Class Store

Store base class

interface

Hierarchy

Store

Indexable

[k: string]: any

Store base class

interface

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Store(size?: number): Store

- Defined in backend/src/store/store.ts:26
Parameters
- Default value size: number = 0
Returns Store

Properties

_fields

_fields: StoreField[]

count

count: number

length

length: number

Accessors

_defaultFields

get _defaultFields(): StoreField[]

- Defined in backend/src/store/store.ts:24
Returns StoreField[]

estimatedSizeInBytes

get estimatedSizeInBytes(): number

- Defined in backend/src/store/store.ts:340
Returns number

Methods

_init

_init(size: number): void

- Defined in backend/src/store/store.ts:41
Initialize the store

Parameters
- size: number
  
  size to initialize
Returns void

_initField

_initField(name: string, size: number, type: TypedArrayString): void

- Defined in backend/src/store/store.ts:59
Initialize a field

Parameters
- name: string
  
  field name
- size: number
  
  element size
- type: TypedArrayString
  
  data type, one of int8, int16, int32, uint8, uint16, uint32, float32
Returns void

addField

addField(name: string, size: number, type: TypedArrayString): void

- Defined in backend/src/store/store.ts:71
Add a field

Parameters
- name: string
  
  field name
- size: number
  
  element size
- type: TypedArrayString
  
  data type, one of int8, int16, int32, uint8, uint16, uint32, float32
Returns void

appendRecords

appendRecords(addedCount: number, newValRec?: undefined | {}): void

- Defined in backend/src/store/store.ts:116
Parameters
- addedCount: number
- Optional newValRec: undefined | {}
Returns void

clear

clear(): void

- Defined in backend/src/store/store.ts:321
Empty the store

Returns void

copyFrom

copyFrom(other: Store, thisOffset: number, otherOffset: number, length: number): void

- Defined in backend/src/store/store.ts:186
Copy data from one store to another

Parameters
- other: Store
  
  store to copy from
- thisOffset: number
  
  offset to start copying to
- otherOffset: number
  
  offset to start copying from
- length: number
  
  number of entries to copy
Returns void

copyWithin

copyWithin(destinationOffset: number, sourceOffset: number, length: number): void

- Defined in backend/src/store/store.ts:210
Copy data within this store

Parameters
- destinationOffset: number
  
  offset to start copying to
- sourceOffset: number
  
  offset to start copying from
- length: number
  
  number of entries to copy
Returns void

dispose

dispose(): void

- Defined in backend/src/store/store.ts:329
Dispose of the store entries and fields

Returns void

growIfFull

growIfFull(): void

- Defined in backend/src/store/store.ts:163
Resize the store to 1.5 times its current size if full

Returns void

insertRecords

insertRecords(index: number, addedCount: number, newValRec?: undefined | {}): void

- Defined in backend/src/store/store.ts:88
Allows to add values to the store fields simultaneously. It is expected that all of the fields provided by the store will have their value defined in the newly added record and all the arrays with values are of the same length.

Parameters
- index: number
  
  index where the data should be inserted
- addedCount: number
- Optional newValRec: undefined | {}
  
  defines the values to add; if not provided, the store will be resized but no values will be overriden
  
  Catana extension.
Returns void

prependRecords

prependRecords(addedCount: number, newValRec?: undefined | {}): void

- Defined in backend/src/store/store.ts:120
Parameters
- addedCount: number
- Optional newValRec: undefined | {}
Returns void

removeRecord

removeRecord(index: number): void

- Defined in backend/src/store/store.ts:124
Parameters
- index: number
Returns void

resize

resize(size?: undefined | number): void

- Defined in backend/src/store/store.ts:136
Resize the store to the new size

Parameters
- Optional size: undefined | number
  
  new size
Returns void

rotate

rotate(shift: number): void

- Defined in backend/src/store/store.ts:299
Left-rotates the array with the given shift in the desired direction In-situ algorithm

Catana extension

Parameters
- shift: number
Returns void

shrinkToFit

shrinkToFit(): void

- Defined in backend/src/store/store.ts:174
Reduces the container length to equal its count. Catana extension.

Returns void

sort

sort(compareFunction: (a: any, b: any) => number): void

- Defined in backend/src/store/store.ts:247
Sort entries in the store given the compare function

Parameters
- compareFunction: (a: any, b: any) => number
  
  function to sort by
  - - (a: any, b: any): number
    - Parameters
      - a: any
      - b: any
      Returns number
Returns void

Generated using TypeDoc