Class ByteArrayBitmapSchemaInternal<T>

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

Type Parameters

T extends BitSchema

Hierarchy (view full)

Schema<TypeFromBitSchema<T>, Uint8Array>
- ByteArrayBitmapSchemaInternal

Index

Constructors

Methods

decode decodeInternal encode encodeInternal validate

Constructors

constructor

new ByteArrayBitmapSchemaInternal<T>(bitSchemas): ByteArrayBitmapSchemaInternal<T>
Type Parameters
- T extends BitSchema
Parameters
- bitSchemas: T
Returns ByteArrayBitmapSchemaInternal<T>
Overrides Schema.constructor
- Defined in packages/types/src/schema/BitmapSchema.ts:113

Methods

decode

decode(encoded, validate?): TypeFromBitSchema<T>
Decodes the encoded data using the schema.
Parameters
- encoded: Uint8Array
- validate: boolean = true
Returns TypeFromBitSchema<T>
Inherited from Schema.decode
- Defined in packages/types/src/schema/Schema.ts:16

decodeInternal

decodeInternal(bitmap): TypeFromBitSchema<T>
Parameters
- bitmap: Uint8Array
Returns TypeFromBitSchema<T>
Overrides Schema.decodeInternal
- Defined in packages/types/src/schema/BitmapSchema.ts:161

encode

encode(value): Uint8Array
Encodes the value using the schema.
Parameters
- value: TypeFromBitSchema<T>
Returns Uint8Array
Inherited from Schema.encode
- Defined in packages/types/src/schema/Schema.ts:10

encodeInternal

encodeInternal(value): Uint8Array
Parameters
- value: TypeFromBitSchema<T>
Returns Uint8Array
Overrides Schema.encodeInternal
- Defined in packages/types/src/schema/BitmapSchema.ts:136

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/src/schema/Schema.ts:28