Interface IPersistScope<J>

interface IPersistScope<J extends IResource.JSON> {
    endPersist(): void;
    fromJSON(json: J[]): void;
    fromResourceId(resourceId: number): JSONSerializableAsync<J> | null;
    toJSONAsync(writer?: Writer): Promise<J[]>;
    toResourceId(resource: JSONSerializableAsync<J>): number | null;
}

Type Parameters

J extends IResource.JSON

Index

Methods

endPersist fromJSON fromResourceId toJSONAsync toResourceId

Methods

endPersist

endPersist(): void

Called when done persisting.

Returns void

fromJSON

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

fromResourceId

fromResourceId(resourceId: number): JSONSerializableAsync<J> | null
For a given resourceId this will return the resource.
Parameters
- resourceId: number
Returns JSONSerializableAsync<J> | null

toJSONAsync

toJSONAsync(writer?: Writer): Promise<J[]>
This can be called multiple times.
Parameters
- Optionalwriter: Writer
  Called once per resource in place of serializing it, to write it elsewhere. Returns [] when the writer records nothing for any of them.
Returns Promise<J[]>

toResourceId

toResourceId(resource: JSONSerializableAsync<J>): number | null
For a resource this will return a number that can be used to reference the resource in the persisted json.
Parameters
- resource: JSONSerializableAsync<J>
Returns number | null