Skip to main content

QEmailCodeFactor

@quik/mfa

@quik/mfa / QEmailCodeFactor

Class: QEmailCodeFactor

Defined in: mfa/src/factors/delivery/QEmailCodeFactor.ts:15

Default email-backed code factor.

Extends​

Constructors​

Constructor​

new QEmailCodeFactor(): QEmailCodeFactor

Defined in: mfa/src/factors/delivery/QEmailCodeFactor.ts:19

Creates an email delivery factor with values from module configuration.

Returns​

QEmailCodeFactor

Overrides​

QCodeFactor.constructor

Properties​

deliver​

protected readonly deliver: CodeDeliveryFn

Defined in: mfa/src/factors/QCodeFactor.ts:42

Code delivery callback.

Inherited from​

QCodeFactor.deliver

length​

protected readonly length: number

Defined in: mfa/src/factors/QCodeFactor.ts:36

Code length in digits.

Inherited from​

QCodeFactor.length

maxAttempts​

protected readonly maxAttempts: number

Defined in: mfa/src/factors/QCodeFactor.ts:40

Default maximum attempts.

Inherited from​

QCodeFactor.maxAttempts

method​

readonly method: string

Defined in: mfa/src/factors/QCodeFactor.ts:34

Factor method key.

Inherited from​

QCodeFactor.method

ttlMs​

protected readonly ttlMs: number

Defined in: mfa/src/factors/QCodeFactor.ts:38

Default challenge TTL in milliseconds.

Inherited from​

QCodeFactor.ttlMs

Accessors​

logger​

Get Signature​

get protected logger(): IQLogger

Defined in: core/src/QObject.ts:15

The logger getter for the object.

Returns​

IQLogger

Inherited from​

QCodeFactor.logger

name​

Get Signature​

get name(): string

Defined in: core/src/QObject.ts:8

Returns​

string

Inherited from​

QCodeFactor.name

Methods​

endSpan()​

protected endSpan(span): void

Defined in: core/src/QObject.ts:35

End a span returned by startSpan.

Parameters​

span​

TelemetrySpan

The span to end.

Returns​

void

Inherited from​

QCodeFactor.endSpan

issue()​

issue(input): Promise<QMFAIssueResult>

Defined in: mfa/src/factors/delivery/QEmailCodeFactor.ts:40

Issues a challenge and dispatches its generated code.

Parameters​

input​

QMFATypedIssueInput<IQEmailCodeMetadata> | Partial<QMFATypedIssueInput<IQEmailCodeMetadata>>

Challenge input.

Returns​

Promise<QMFAIssueResult>

Overrides​

QCodeFactor.issue

recordSpanError()​

protected recordSpanError(span, err): void

Defined in: core/src/QObject.ts:45

Record an exception on an active span.

Parameters​

span​

TelemetrySpan

The span to record the error on.

err​

unknown

The error to record.

Returns​

void

Inherited from​

QCodeFactor.recordSpanError

setSpanAttribute()​

protected setSpanAttribute(span, key, value): void

Defined in: core/src/QObject.ts:64

Set a single attribute on an active span.

Parameters​

span​

TelemetrySpan

The span to update.

key​

string

Attribute key.

value​

string | number | boolean

Attribute value.

Returns​

void

Inherited from​

QCodeFactor.setSpanAttribute

startSpan()​

protected startSpan(spanName, options?): TelemetrySpan

Defined in: core/src/QObject.ts:26

Start a telemetry span for the given operation name. Returns undefined when no telemetry provider is active.

Parameters​

spanName​

string

Name of the span.

options?​

TelemetrySpanOptions

Optional span attributes and kind.

Returns​

TelemetrySpan

Inherited from​

QCodeFactor.startSpan

verify()​

verify(input): Promise<boolean>

Defined in: mfa/src/factors/QCodeFactor.ts:87

Verifies a submitted code against the stored challenge hash.

Parameters​

input​

QMFAVerifyInput | Partial<QMFAVerifyInput>

Verification input.

Returns​

Promise<boolean>

Inherited from​

QCodeFactor.verify