Class IdentityTransformer

Identity transformer. Values are transformed to themselves.

Hierarchy (View Summary)

Transformer
- IdentityTransformer

Index

Constructors

Accessors

Methods

get doForward doReverse forward reverse

Constructors

constructor

new IdentityTransformer(domain: number | bigint): IdentityTransformer
Constructor.
Parameters
- domain: number | bigint
  Domain.
Returns IdentityTransformer
Inherited from Transformer.constructor
- Defined in transformer.ts:119

Accessors

domain

get domain(): bigint
Get the domain.

Returns bigint
Inherited from Transformer.domain
- Defined in transformer.ts:169

Methods

`Static`get

get(domain: number | bigint, tweak?: number | bigint): Transformer
Get a transformer, constructing it if necessary. The type returned is IdentityTransformer if tweak is undefined, EncryptionTransformer if tweak is defined. Note that although an EncryptionTransformer with a zero tweak operates as an IdentityTransformer, EncryptionTransformer is still the type returned if a zero tweak is explicitly specified.
Parameters
- domain: number | bigint
  Domain.
- Optionaltweak: number | bigint
  Tweak.
Returns Transformer
IdentityTransformer if tweak is undefined, EncryptionTransformer if tweak is defined.
Inherited from Transformer.get
- Defined in transformer.ts:144

`Protected`doForward

doForward(value: bigint): bigint
Do the work of transforming a value forward.
Parameters
- value: bigint
  Value.
Returns bigint
Transformed value.
Overrides Transformer.doForward
- Defined in transformer.ts:343

`Protected`doReverse

doReverse(transformedValue: bigint): bigint
Do the work of transforming a value in reverse.
Parameters
- transformedValue: bigint
  Transformed value.
Returns bigint
Value.
Overrides Transformer.doReverse
- Defined in transformer.ts:350

forward

forward<TTransformerInput extends TransformerInput<number | bigint>>(
valueOrValues: TTransformerInput,
): TransformerOutput<TTransformerInput, bigint>
Transform value(s) forward.
Type Parameters
- TTransformerInput extends TransformerInput<number | bigint>
  Value(s) input type.
Parameters
- valueOrValues: TTransformerInput
  Value(s). If this is an instance of Sequence, the minimum and maximum values are validated prior to transformation. Otherwise, the individual value(s) is/are validated at the time of transformation.
Returns TransformerOutput<TTransformerInput, bigint>
Transformed value(s).
Inherited from Transformer.forward
- Defined in transformer.ts:254
forward<TTransformerInput extends TransformerInput<number | bigint>, TOutput>(
valueOrValues: TTransformerInput,
transformerCallback: TransformerCallback<bigint, TOutput>,
): TransformerOutput<TTransformerInput, TOutput>
Transform value(s) forward, optionally applying a transformation.
Type Parameters
- TTransformerInput extends TransformerInput<number | bigint>
  Value(s) input type.
- TOutput
  Transformation callback output type.
Parameters
- valueOrValues: TTransformerInput
  Value(s). If this is an instance of Sequence, the minimum and maximum values are validated prior to transformation. Otherwise, the individual value(s) is/are validated at the time of transformation.
- transformerCallback: TransformerCallback<bigint, TOutput>
  Called after each value is transformed to convert it to its final value.
Returns TransformerOutput<TTransformerInput, TOutput>
Transformed value(s).
Inherited from Transformer.forward
- Defined in transformer.ts:275

reverse

reverse(transformedValue: number | bigint): bigint
Transform a value in reverse.
Parameters
- transformedValue: number | bigint
  Transformed value.
Returns bigint
Value.
Inherited from Transformer.reverse
- Defined in transformer.ts:327