Class BitmapSchemaInternal<T>

Define a schema to encode / decode convert type T to type E.

Type Parameters

T extends BitSchema

Hierarchy (view full)

Schema<TypeFromBitSchema<T>, number>
- BitmapSchemaInternal

Index

Constructors

Methods

decode decodeInternal encode encodeInternal validate

Constructors

constructor

new BitmapSchemaInternal<T>(bitSchemas): BitmapSchemaInternal<T>
Type Parameters
- T extends BitSchema
Parameters
- bitSchemas: T
Returns BitmapSchemaInternal<T>
Overrides Schema.constructor
- Defined in packages/types/dist/esm/schema/BitmapSchema.d.ts:42

Methods

decode

decode(encoded, validate?): TypeFromBitSchema<T>
Decodes the encoded data using the schema.
Parameters
- encoded: number
- Optionalvalidate: boolean
Returns TypeFromBitSchema<T>
Inherited from Schema.decode
- Defined in packages/types/dist/esm/schema/Schema.d.ts:11

decodeInternal

decodeInternal(bitmap): TypeFromBitSchema<T>
Parameters
- bitmap: number
Returns TypeFromBitSchema<T>
Overrides Schema.decodeInternal
- Defined in packages/types/dist/esm/schema/BitmapSchema.d.ts:49

encode

encode(value): number
Allow to use a fully defined Bitmap schema as input, but also allow one where only the entries of bits set are provided, rest is unset.
Parameters
- value: TypeFromPartialBitSchema<T>
Returns number
Overrides Schema.encode
- Defined in packages/types/dist/esm/schema/BitmapSchema.d.ts:47

encodeInternal

encodeInternal(value): number
Parameters
- value: TypeFromPartialBitSchema<T>
Returns number
Overrides Schema.encodeInternal
- Defined in packages/types/dist/esm/schema/BitmapSchema.d.ts:48

validate

validate(_value): void
Optional validator that can be used to enforce constraints on the data before encoding / after decoding.
Parameters
- _value: TypeFromBitSchema<T>
Returns void
Inherited from Schema.validate
- Defined in packages/types/dist/esm/schema/Schema.d.ts:15