step.score

Record a score of the run.

nelkap.step.score(name: string, value: number | boolean): Promise<void>

Parameters

name · string · required

The score’s name, up to 128 characters. Runs that share it share a chart.

value · number | boolean · required

A number, charted as an average, or a yes or no, charted as a pass rate.

Behavior

The score is saved like any step. Every call after skips it, so a run records it once.

Errors

Error	When
NelkapError badRequest	The name breaks a rule above.
NelkapError stepLimitReached	The run has reached its limit of steps.
Error	It was called outside a run.

Example

const reply = await nelkap.step.run('reply', () => draftReply(ticketId));

await nelkap.step.score('resolved', reply.resolved);
await nelkap.step.score('confidence', reply.confidence);