Data-Mate: `Builder Builder Builder`
builder/Builder.Builder
Since Vectors are immutable, a Builder can be used to construct a Vector. When values are inserted they are coerced and validated.
Type parameters
Name | Type |
---|---|
T | unknown |
Hierarchy
Builder
Table of contents
Constructors
Properties
Methods
Constructors
constructor
• new Builder<T
>(type
, data
, options
): Builder
<T
>
Type parameters
Name | Type |
---|---|
T | unknown |
Parameters
Name | Type | Description |
---|---|---|
type | VectorType | This will be set automatically by specific Builder classes |
data | WritableData <T > | - |
options | BuilderOptions | - |
Returns
Builder
<T
>
Defined in
data-mate/src/builder/Builder.ts:80
Properties
childConfig
• Optional
Readonly
childConfig: DataTypeFields
When Vector is an object type, this will be the data type fields for the object
Defined in
data-mate/src/builder/Builder.ts:63
config
• Readonly
config: Readonly
<DataTypeFieldConfig
>
The field type configuration
Defined in
data-mate/src/builder/Builder.ts:57
currentIndex
• currentIndex: number
The current insertion index (used for append)
Defined in
data-mate/src/builder/Builder.ts:78
data
• Readonly
data: WritableData
<T
>
Defined in
data-mate/src/builder/Builder.ts:68
name
• Optional
Readonly
name: string
The name of field, if specified this will just be used for metadata
Defined in
data-mate/src/builder/Builder.ts:73
type
• Readonly
type: VectorType
The type of Vector, this should only be set with the specific Vector type classes.
Defined in
data-mate/src/builder/Builder.ts:52
Methods
_valueFrom
▸ _valueFrom(value
): T
Convert a value to the internal in-memory storage format for the Vector
Parameters
Name | Type |
---|---|
value | unknown |
Returns
T
Defined in
data-mate/src/builder/Builder.ts:101
append
▸ append(value
): Builder
<T
>
Append a value to the end
Parameters
Name | Type |
---|---|
value | unknown |
Returns
Builder
<T
>
Defined in
data-mate/src/builder/Builder.ts:161
mset
▸ mset(value
, indices
): Builder
<T
>
Set a single unique value on multiple indices
Parameters
Name | Type |
---|---|
value | unknown |
indices | Iterable <number > |
Returns
Builder
<T
>
Defined in
data-mate/src/builder/Builder.ts:150
resize
▸ resize(size
): Builder
<T
>
Resize the amount of records stored in in the writable data structure
Parameters
Name | Type |
---|---|
size | number |
Returns
Builder
<T
>
Defined in
data-mate/src/builder/Builder.ts:169
set
▸ set(index
, value
): Builder
<T
>
Set value by index
Parameters
Name | Type |
---|---|
index | number |
value | unknown |
Returns
Builder
<T
>
Defined in
data-mate/src/builder/Builder.ts:142
toVector
▸ toVector(): Vector
<T
>
Flush and convert the result to a Vector
Returns
Vector
<T
>
Defined in
data-mate/src/builder/Builder.ts:179
valueFrom
▸ valueFrom(value
, indices?
): T
Convert a value to the internal in-memory storage format for the Vector
Parameters
Name | Type | |
---|---|---|
value | unknown | |
indices? | number \ | Iterable <number > |
Returns
T
Defined in
data-mate/src/builder/Builder.ts:106
make
▸ make<R
>(data
, options
): Builder
<R
>
Make an instance of a Builder from a DataTypeFieldConfig
Type parameters
Name | Type |
---|---|
R | unknown |
Parameters
Name | Type |
---|---|
data | WritableData <R > |
options | BuilderOptions |
Returns
Builder
<R
>
Defined in
data-mate/src/builder/Builder.ts:18
makeFromVector
▸ makeFromVector<R
>(vector
, size
): Builder
<R
>
Convert a Vector to a Builder with current values populated depending on the length populated
Type parameters
Name |
---|
R |
Parameters
Name | Type |
---|---|
vector | Vector <R > |
size | number |
Returns
Builder
<R
>