Data-Mate: `Core Readable Data Readable Data`
core/ReadableData.ReadableData
A generic readonly optimized view of data used for Vectors.
Type parameters
Name |
---|
T |
Implements
Iterable
<Maybe
<T
>>
Table of contents
Constructors
Properties
Accessors
Methods
Constructors
constructor
• new ReadableData<T
>(data
): ReadableData
<T
>
Type parameters
Name |
---|
T |
Parameters
Name | Type |
---|---|
data | WritableData <T > |
Returns
ReadableData
<T
>
Defined in
data-mate/src/core/ReadableData.ts:23
Properties
size
• Readonly
size: number
The number of total number of values stored
Defined in
data-mate/src/core/ReadableData.ts:21
emptyData
▪ Static
emptyData: ReadableData
<any
>
Defined in
data-mate/src/core/ReadableData.ts:11
Accessors
isPrimitive
• get
isPrimitive(): boolean
A flag to indicate whether the values stored a javascript primitive. For example, boolean, string, symbol, number, bigint, etc. If false the values will require more complicated unique checks
Returns
boolean
Default
true
Defined in
data-mate/src/core/ReadableData.ts:46
Methods
[iterator]
▸ [iterator](): IterableIterator
<Maybe
<T
>>
Returns
IterableIterator
<Maybe
<T
>>
Implementation of
Iterable.[iterator]
Defined in
data-mate/src/core/ReadableData.ts:50
countValues
▸ countValues(): number
Get the number of non-nil values
Returns
number
Defined in
data-mate/src/core/ReadableData.ts:136
entries
▸ entries(): Iterable
<[index: number, value: T]>
Iterate over the non-nil values with indices
Returns
Iterable
<[index: number, value: T]>
Defined in
data-mate/src/core/ReadableData.ts:66
get
▸ get(index
): Maybe
<T
>
Get a value by an index
Parameters
Name | Type |
---|---|
index | number |
Returns
Maybe
<T
>
Defined in
data-mate/src/core/ReadableData.ts:73
has
▸ has(index
): boolean
Check if the contains a particular value
Parameters
Name | Type |
---|---|
index | number |
Returns
boolean
Defined in
data-mate/src/core/ReadableData.ts:80
hasNilValues
▸ hasNilValues(): boolean
Check to see there are any nil values stored
Returns
boolean
Defined in
data-mate/src/core/ReadableData.ts:129
isEmpty
▸ isEmpty(): boolean
Returns true if there are no non-nil values
Returns
boolean
Defined in
data-mate/src/core/ReadableData.ts:143
slice
▸ slice(start?
, end?
): WritableData
<T
>
Create a new Data with the range of values
Parameters
Name | Type | Default value |
---|---|---|
start | number | 0 |
end | number | undefined |
Returns
WritableData
<T
>
Defined in
data-mate/src/core/ReadableData.ts:99
toWritable
▸ toWritable(size?
): WritableData
<T
>
Fork the Data object with specific length.
Parameters
Name | Type | Description |
---|---|---|
size? | number | optionally change the size of the Data |
Returns
WritableData
<T
>
Defined in
data-mate/src/core/ReadableData.ts:89
values
▸ values(): Iterable
<T
>
Iterate over the non-nil values
Returns
Iterable
<T
>