Interface IPersistScope<J>

A transient scope for items to ids that can be used for references.

See

IPersistable.beginPersist

interface IPersistScope<J = any> {
    add(item: J | JSONSerializableAsync<J>): number;
    at(id: number): J | JSONSerializableAsync<J>;
    endPersist(): void;
    fromJSON(json: J[]): void;
    toJSONAsync(): Promise<J[]>;
}

Type Parameters

J = any

Index

Methods

add at endPersist fromJSON toJSONAsync

Methods

add

add(item: J | JSONSerializableAsync<J>): number
For a shared string this will return a number that can be used to reference the item in the persisted json.
Parameters
- item: J | JSONSerializableAsync<J>
  The to return an identifier for.
Returns number

at

at(id: number): J | JSONSerializableAsync<J>
For a given persist id this will return the item.
Parameters
- id: number
Returns J | JSONSerializableAsync<J>

endPersist

endPersist(): void
Called when done persisting.

Returns void

fromJSON

fromJSON(json: J[]): void
Loads the json.
Parameters
- json: J[]
Returns void

toJSONAsync

toJSONAsync(): Promise<J[]>
Return a array of resources that have been added via add.

Returns Promise<J[]>
Remarks
This can be called multiple times..