Class RecordV2DataTypeImpl

A data type for RecordV2 values

Hierarchy

any
- RecordV2DataTypeImpl

Implements

RecordV2DataType

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new RecordV2DataTypeImpl(validator?: function): RecordV2DataTypeImpl

- Defined in internal/data/record/recordv2-datatype-impl.ts:45
Create a new RecordV2DataTypeImpl instance

Parameters
- Default value validator: function = defaultValidator
  
  a validator for validating RecordV2 instances
  - - (value: RecordV2Impl): void
    - Parameters
      - value: RecordV2Impl
      Returns void
Returns RecordV2DataTypeImpl

Properties

RecordV2

RecordV2: any = RecordV2Impl

The implementation of the underlying value type

Private validator

validator: function

A validator for validating RecordV2 instances.

param: the record to validate
throws: an error if the value is not valid

Type declaration

- (value: RecordV2Impl): void
- Parameters
  - value: RecordV2Impl
  Returns void

Methods

from

from(value: RecordV2 | BufferSlice | Buffer): RecordV2Impl

- Defined in internal/data/record/recordv2-datatype-impl.ts:70
Create a new RecordV2 instance from data

Parameters
- value: RecordV2 | BufferSlice | Buffer
  
  the CBOR data containing the record
Returns RecordV2Impl

a new RecordV2 instance

parseSchema

parseSchema(json: string): SchemaImpl

Implementation of RecordV2DataType.parseSchema
- Defined in internal/data/record/recordv2-datatype-impl.ts:89
Parse a JSON string into a RecordV2 schema

parame

the schema parsed from the JSON string

Parameters
- json: string
  
  the JSON string
Returns SchemaImpl

schemaBuilder

schemaBuilder(): SchemaBuilderImpl

Implementation of RecordV2DataType.schemaBuilder
- Defined in internal/data/record/recordv2-datatype-impl.ts:98
Create a new schema builder

Returns SchemaBuilderImpl

a schema builder

validate

validate(value: RecordV2Impl): void

- Defined in internal/data/record/recordv2-datatype-impl.ts:79
Validate a RecordV2 object

inheritdoc

Parameters
- value: RecordV2Impl
Returns void

valueBuilder

valueBuilder(): RecordV2BuilderImpl

Implementation of RecordV2DataType.valueBuilder
- Defined in internal/data/record/recordv2-datatype-impl.ts:108
Create a new value builder that can be used to build a RecordV2 value

Returns RecordV2BuilderImpl

a new value builder

withSchema

withSchema(schema: Schema): RecordV2DataTypeImpl

Implementation of RecordV2DataType.withSchema
- Defined in internal/data/record/recordv2-datatype-impl.ts:118
Create a new RecordV2DataTypeImpl with a schema.

Parameters
- schema: Schema
  
  the schema to validate against
Returns RecordV2DataTypeImpl

a new RecordV2 Data Type