External module "data/Collection"

Index

Classes

Interfaces

Functions

Object literals

defaultOpts

Functions

Const clientSideCollection

clientSideCollection<E>(entityName: string, opts?: ClientSideDataCollectionOptions): ClientSideDataCollectionStore<E>

- Defined in src/data/Collection.tsx:441
Initialization function that instantiates a ClientSideDataCollectionStore implementation

Type parameters
- E: __type
  
  entity type.
Parameters
- entityName: string
  
  name of the entity to be retrieved.
- Default value opts: ClientSideDataCollectionOptions = defaultOpts
  
  ClientSideDataCollectionStore configuration.
Returns ClientSideDataCollectionStore<E>

Const collection

collection<E>(entityName: string, opts?: DataCollectionOptions): DataCollectionStore<E>

- Defined in src/data/Collection.tsx:429
Initialization function that instantiates a DataCollectionStore implementation which uses Generic REST API as the source.

Type parameters
- E: __type
  
  entity type.
Parameters
- entityName: string
  
  name of the entity to be retrieved.
- Default value opts: DataCollectionOptions = defaultOpts
  
  DataCollectionStore configuration.
Returns DataCollectionStore<E>

createClientSideStore

createClientSideStore<E>(entityName: string, opts: ClientSideDataCollectionOptions): ClientSideDataCollectionStore<E>

- Defined in src/data/Collection.tsx:362
Type parameters
- E
Parameters
- entityName: string
- opts: ClientSideDataCollectionOptions
Returns ClientSideDataCollectionStore<E>

createStore

createStore<E>(entityName: string, opts: DataCollectionOptions): DataCollectionStore<E>

- Defined in src/data/Collection.tsx:356
Type parameters
- E
Parameters
- entityName: string
- opts: DataCollectionOptions
Returns DataCollectionStore<E>

fromRestModel

fromRestModel<T>(items: Array<SerializedEntity<T>>, stringIdName?: undefined | string): Array<SerializedEntity<T>>

- Defined in src/data/Collection.tsx:342
Type parameters
- T
Parameters
- items: Array<SerializedEntity<T>>
- Optional stringIdName: undefined | string
Returns Array<SerializedEntity<T>>

setOptionsAndLoad

setOptionsAndLoad<E>(dataCollection: DataCollectionStore<E>, opts: DataCollectionOptions): void

- Defined in src/data/Collection.tsx:371
Type parameters
- E
Parameters
- dataCollection: DataCollectionStore<E>
- opts: DataCollectionOptions
Returns void

Const useCollection

useCollection<T>(entityName: string, opts: DataCollectionOptions): MutableRefObject<DataCollectionStore<T>>

- Defined in src/data/Collection.tsx:412
A hook that returns a mutable ref object containing a DataCollectionStore initialized with provided entity name and options. The DataCollectionStore value will be preserved between renders.

Type parameters
- T: __type
  
  entity type.
Parameters
- entityName: string
- opts: DataCollectionOptions
Returns MutableRefObject<DataCollectionStore<T>>

Const withDataCollection

withDataCollection(entityName: string, opts?: DataCollectionOptions): (Anonymous function)

- Defined in src/data/Collection.tsx:395
Parameters
- entityName: string
- Default value opts: DataCollectionOptions = defaultOpts
Returns (Anonymous function)

Object literals

Const defaultOpts

defaultOpts: object

loadImmediately

loadImmediately: true = true

Generated using TypeDoc