Interface EmbeddedAPI

Provides the public embedded reactive collection API.

interface EmbeddedAPI {
    create<T extends NamedDocumentConstructor>(
        doc: T,
        options: DynOptionsMapCreate<string, InstanceType<T>>,
    ): DynMapReducer<string, InstanceType<T>>;
    destroy<T extends NamedDocumentConstructor>(
        doc?: T,
        storeName?: string,
    ): boolean;
    get<T extends NamedDocumentConstructor>(
        doc: T,
        storeName: string,
    ): DynMapReducer<string, InstanceType<T>>;
}

Index

Methods

create destroy get

Methods

create

create<T extends NamedDocumentConstructor>(
doc: T,
options: DynOptionsMapCreate<string, InstanceType<T>>,
): DynMapReducer<string, InstanceType<T>>
Creates an embedded collection store.
Type Parameters
- T extends NamedDocumentConstructor
Parameters
- doc: T
- options: DynOptionsMapCreate<string, InstanceType<T>>
Returns DynMapReducer<string, InstanceType<T>>

destroy

destroy<T extends NamedDocumentConstructor>(
doc?: T,
storeName?: string,
): boolean
- Destroys one or more embedded collection stores.
Type Parameters
- T extends NamedDocumentConstructor
Parameters
- Optionaldoc: T
- OptionalstoreName: string
Returns boolean

get

get<T extends NamedDocumentConstructor>(
doc: T,
storeName: string,
): DynMapReducer<string, InstanceType<T>>
- Returns a specific existing embedded collection store.
Type Parameters
- T extends NamedDocumentConstructor
Parameters
- doc: T
- storeName: string
Returns DynMapReducer<string, InstanceType<T>>