Interface CyberDeepClientInstance<L>

interface CyberDeepClientInstance<L> {
    DeepClient: typeof DeepClient;
    DeepContext: Context<DeepClient<Link<Id>>>;
    DeepProvider: ((__namedParameters: {
        apolloClient?: IApolloClient<any>;
        children: any;
        minilinks?: MinilinkCollection<MinilinksGeneratorOptions, Link<Id>>;
        namespace?: string;
    }) => Element);
    apolloClient: IApolloClient<any>;
    deep: DeepClientInstance<L>;
    defaultDeleteName?: string;
    defaultInsertName?: string;
    defaultSelectName?: string;
    defaultUpdateName?: string;
    deleteReturning?: string;
    filesSelectReturning?: string;
    handleAuth?: ((linkId?: Id, token?: string) => any);
    insertReturning?: string;
    linkId?: Id;
    linksSelectReturning?: string;
    minilinks: MinilinksResult<L>;
    namespace?: string;
    returning?: string;
    selectReturning?: string;
    selectorsSelectReturning?: string;
    table?: string;
    token?: string;
    unsafe?: any;
    updateReturning?: string;
    useDeep: (() => DeepClient<Link<Id>>);
    useDeepId: ((start: QueryLink | DeepClientStartItem, ...path: DeepClientPathItem[]) => {
        data: Id;
        error?: any;
        loading: boolean;
    });
    useDeepQuery: (<Table, LL>(query: Exp<Table>, options?: Options<Table>) => {
        data?: LL[];
        error?: any;
        loading: boolean;
    });
    useDeepSubscription: (<Table, LL>(query: Exp<Table>, options?: Options<Table>) => UseDeepSubscriptionResult<LL>);
    useMinilinksQuery: ((query: Exp<"links">) => L[]);
    useMinilinksSubscription: ((query: Exp<"links">) => L[]);
    valuesSelectReturning?: string;
    Traveler(links: Link<Id>[]): Traveler;
    await(id: Id): Promise<boolean>;
    can(objectIds: Id[], subjectIds: Id[], actionIds: Id[]): Promise<boolean>;
    delete<TTable>(exp: Exp<TTable>, options?: WriteOptions<TTable>): Promise<DeepClientResult<{
        id: any;
    }[]>>;
    guest(options: DeepClientGuestOptions): Promise<DeepClientAuthResult>;
    id(start:
        | string
        | number
        | QueryLink
        | Id[], ...path: DeepClientPathItem[]): Promise<Id>;
    idLocal(start: DeepClientStartItem, ...path: DeepClientPathItem[]): Id;
    insert<TTable, LL>(objects: InsertObjects<TTable>, options?: WriteOptions<TTable>): Promise<DeepClientResult<{
        id: any;
    }[]>>;
    jwt(options: DeepClientJWTOptions): Promise<DeepClientAuthResult>;
    login(options: DeepClientJWTOptions): Promise<DeepClientAuthResult>;
    logout(): Promise<DeepClientAuthResult>;
    reserve<LL>(count: number): Promise<Id[]>;
    select<TTable, LL>(exp: Exp<TTable>, options?: ReadOptions<TTable>): Promise<DeepClientResult<number | LL[]>>;
    serial(options: AsyncSerialParams): Promise<DeepClientResult<{
        id: any;
    }[]>>;
    serializeQuery(exp: any, env?: string): any;
    serializeWhere(exp: any, env?: string): any;
    stringify(any?: any): string;
    subscribe<TTable, LL>(exp: Exp<TTable>, options?: ReadOptions<TTable>): Observable<number | LL[]>;
    unvertualizeId(id: Id): Id;
    update<TTable>(exp: Exp<TTable>, value: UpdateValue<TTable>, options?: WriteOptions<TTable>): Promise<DeepClientResult<{
        id: any;
    }[]>>;
}

Type Parameters

Hierarchy (view full)

Implemented by

Properties

DeepClient: typeof DeepClient
DeepContext: Context<DeepClient<Link<Id>>>
DeepProvider: ((__namedParameters: {
    apolloClient?: IApolloClient<any>;
    children: any;
    minilinks?: MinilinkCollection<MinilinksGeneratorOptions, Link<Id>>;
    namespace?: string;
}) => Element)
apolloClient: IApolloClient<any>
defaultDeleteName?: string
defaultInsertName?: string
defaultSelectName?: string
defaultUpdateName?: string
deleteReturning?: string
filesSelectReturning?: string
handleAuth?: ((linkId?: Id, token?: string) => any)
insertReturning?: string
linkId?: Id
linksSelectReturning?: string
minilinks: MinilinksResult<L>
namespace?: string
returning?: string
selectReturning?: string
selectorsSelectReturning?: string
table?: string
token?: string
unsafe?: any
updateReturning?: string
useDeep: (() => DeepClient<Link<Id>>)
useDeepId: ((start: QueryLink | DeepClientStartItem, ...path: DeepClientPathItem[]) => {
    data: Id;
    error?: any;
    loading: boolean;
})
useDeepQuery: (<Table, LL>(query: Exp<Table>, options?: Options<Table>) => {
    data?: LL[];
    error?: any;
    loading: boolean;
})
useDeepSubscription: (<Table, LL>(query: Exp<Table>, options?: Options<Table>) => UseDeepSubscriptionResult<LL>)
useMinilinksQuery: ((query: Exp<"links">) => L[])
useMinilinksSubscription: ((query: Exp<"links">) => L[])
valuesSelectReturning?: string

Methods