Interface DeepClientInstance<L>

interface DeepClientInstance<L> {
    apolloClient: IApolloClient<any>;
    canSelectReturning?: string;
    deep: DeepClientInstance<L>;
    DeepClient: typeof DeepClient;
    DeepContext: Context<DeepClient<Link<Id>>>;
    DeepProvider: ((__namedParameters: {
        apolloClient?: IApolloClient<any>;
        children?: any;
        minilinks?: MinilinkCollection<MinilinksGeneratorOptions, Link<Id>>;
        namespace?: string;
        path?: string;
        secret?: string;
        ssl?: boolean;
        token?: string;
        ws?: boolean;
    }) => Element);
    defaultDeleteName?: string;
    defaultInsertName?: string;
    defaultSelectName?: string;
    defaultUpdateName?: string;
    deleteReturning?: string;
    emitter: EventEmitter<DefaultEventMap>;
    eval: ((options: {
        context?: Id[];
        handlerId?: Id;
        input?: any;
        linkId?: Id;
        value?: string;
    }) => Promise<{
        data?: any;
        error?: any;
    }>);
    filesSelectReturning?: string;
    gql: typeof gql;
    handleAuth?: ((linkId?: Id, token?: string) => any);
    handleOperation?: ((operation: string, query?: any, value?: any, options?: any) => any);
    handlersSelectReturning?: string;
    insertReturning?: string;
    linkId?: Id;
    linksSelectReturning?: string;
    minilinks: MinilinksResult<L>;
    ml: MinilinksResult<L>;
    namespace?: string;
    Query: NamedExoticComponent<any>;
    returning?: string;
    secret?: string;
    selectorsSelectReturning?: string;
    selectReturning?: string;
    ssl?: boolean;
    Subscription: NamedExoticComponent<any>;
    table?: string;
    token?: string;
    treeSelectReturning?: string;
    unsafe?: any;
    updateReturning?: string;
    url: ((target: "deeplinks" | "gql") => string);
    useCan: ((objectId: Id | Id[], subjectId: Id | Id[], actionId: Id | Id[]) => {
        data: boolean | void;
        loading: boolean;
        refetch: (() => Promise<boolean>);
    });
    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;
        refetch?: (() => Promise<any>);
    });
    useDeepSubscription: (<Table, LL>(query: Exp<Table>, options?: Options<Table>) => UseDeepSubscriptionResult<LL>);
    useId: ((start: QueryLink | DeepClientStartItem, ...path: DeepClientPathItem[]) => {
        data: Id;
        error?: any;
        loading: boolean;
    });
    useLink: ((link: Id | Link<Id>) => MinilinksLink<Id>);
    useLinks: ((...links: (Id | Link<Id>)[]) => MinilinksLink<Id>[]);
    useLocalId: ((start: QueryLink | DeepClientStartItem, ...path: DeepClientPathItem[]) => void | Id);
    useLocalQuery: ((query: Exp<"links">, options?: MinilinksQueryOptions<MinilinksQueryOptionAggregate>) => L[]);
    useLocalSubscription: ((query: Exp<"links">, options?: MinilinksQueryOptions<MinilinksQueryOptionAggregate>) => L[]);
    useMinilinksId: ((start: QueryLink | DeepClientStartItem, ...path: DeepClientPathItem[]) => void | Id);
    useMinilinksQuery: ((query: Exp<"links">, options?: MinilinksQueryOptions<MinilinksQueryOptionAggregate>) => L[]);
    useMinilinksSubscription: ((query: Exp<"links">, options?: MinilinksQueryOptions<MinilinksQueryOptionAggregate>) => L[]);
    useQuery: (<Table, LL>(query: Exp<Table>, options?: Options<Table>) => {
        data?: LL[];
        error?: any;
        loading: boolean;
        refetch?: (() => Promise<any>);
    });
    useSearch: ((value: string, options?: DeepSearchOptions) => any);
    useSubscription: (<Table, LL>(query: Exp<Table>, options?: Options<Table>) => UseDeepSubscriptionResult<LL>);
    valuesSelectReturning?: string;
    ws?: boolean;
    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;
    }[]>>;
    get(...id: Id[]): MinilinksLink<Id>;
    getRemote(...id: Id[]): Promise<MinilinksLink<Id>>;
    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;
    }[]>>;
    isId(id: any): boolean;
    isLink(link: any): boolean;
    jwt(options: DeepClientJWTOptions): Promise<DeepClientAuthResult>;
    login(options: DeepClientJWTOptions): Promise<DeepClientAuthResult>;
    logout(): Promise<DeepClientAuthResult>;
    name(input: Id | Link<Id>): Promise<string>;
    nameLocal(input: Id | Link<Id>): string;
    one(exp:
        | string
        | number
        | QueryLink
        | Id[]): Promise<L>;
    Packager(): Packager<L>;
    Packages(): Packages;
    reserve<LL>(count: number): Promise<Id[]>;
    search(value: string, options: DeepSearchOptions): Promise<DeepClientResult<number | L[]>>;
    searchQuery(value: string, options: {
        contains: boolean;
        db: boolean;
        query: boolean;
        regexp: boolean;
        sort: boolean;
        values: boolean;
    }): Exp<"links">;
    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<DeepClientResult<number | LL[]>>;
    symbol(input: Id | Link<Id>): Promise<string>;
    symbolLocal(input: Id | Link<Id>): string;
    Traveler(links: Link<Id>[]): Traveler;
    unvertualizeId(id: Id): Id;
    update<TTable>(exp: Exp<TTable>, value: UpdateValue<TTable>, options?: WriteOptions<TTable>): Promise<DeepClientResult<{
        id: any;
    }[]>>;
    useLocalApply(data: any, name: string): any;
    useMinilinksApply(data: any, name: string): any;
    value(id: Id, value?: string | number | Object): Promise<{
        data: string | number | Object;
        id: Id;
        link?: Link<Id>;
        Value?: Link<Id>;
        [key: string]: any;
    }>;
}

Type Parameters

Hierarchy (view full)

Implemented by

Properties

apolloClient canSelectReturning? deep DeepClient DeepContext DeepProvider defaultDeleteName? defaultInsertName? defaultSelectName? defaultUpdateName? deleteReturning? emitter eval filesSelectReturning? gql handleAuth? handleOperation? handlersSelectReturning? insertReturning? linkId? linksSelectReturning? minilinks ml namespace? Query returning? secret? selectorsSelectReturning? selectReturning? ssl? Subscription table? token? treeSelectReturning? unsafe? updateReturning? url useCan useDeep useDeepId useDeepQuery useDeepSubscription useId useLink useLinks useLocalId useLocalQuery useLocalSubscription useMinilinksId useMinilinksQuery useMinilinksSubscription useQuery useSearch useSubscription valuesSelectReturning? ws?

Methods

await can delete get getRemote guest id idLocal insert isId isLink jwt login logout name nameLocal one Packager Packages reserve search searchQuery select serial serializeQuery serializeWhere stringify subscribe symbol symbolLocal Traveler unvertualizeId update useLocalApply useMinilinksApply value

Properties

apolloClient

apolloClient: IApolloClient<any>

OptionalcanSelectReturning

canSelectReturning?: string

deep

deep: DeepClientInstance<L>

DeepClient

DeepClient: typeof DeepClient

DeepContext

DeepContext: Context<DeepClient<Link<Id>>>

DeepProvider

DeepProvider: ((__namedParameters: {
    apolloClient?: IApolloClient<any>;
    children?: any;
    minilinks?: MinilinkCollection<MinilinksGeneratorOptions, Link<Id>>;
    namespace?: string;
    path?: string;
    secret?: string;
    ssl?: boolean;
    token?: string;
    ws?: boolean;
}) => Element)

OptionaldefaultDeleteName

defaultDeleteName?: string

OptionaldefaultInsertName

defaultInsertName?: string

OptionaldefaultSelectName

defaultSelectName?: string

OptionaldefaultUpdateName

defaultUpdateName?: string

OptionaldeleteReturning

deleteReturning?: string

emitter

emitter: EventEmitter<DefaultEventMap>

eval

eval: ((options: {
    context?: Id[];
    handlerId?: Id;
    input?: any;
    linkId?: Id;
    value?: string;
}) => Promise<{
    data?: any;
    error?: any;
}>)

OptionalfilesSelectReturning

filesSelectReturning?: string

gql

gql: typeof gql

OptionalhandleAuth

handleAuth?: ((linkId?: Id, token?: string) => any)

OptionalhandleOperation

handleOperation?: ((operation: string, query?: any, value?: any, options?: any) => any)

OptionalhandlersSelectReturning

handlersSelectReturning?: string

OptionalinsertReturning

insertReturning?: string

OptionallinkId

linkId?: Id

OptionallinksSelectReturning

linksSelectReturning?: string

minilinks

minilinks: MinilinksResult<L>

ml

ml: MinilinksResult<L>

Optionalnamespace

namespace?: string

Query

Query: NamedExoticComponent<any>

Optionalreturning

returning?: string

Optionalsecret

secret?: string

OptionalselectorsSelectReturning

selectorsSelectReturning?: string

OptionalselectReturning

selectReturning?: string

Optionalssl

ssl?: boolean

Subscription

Subscription: NamedExoticComponent<any>

Optionaltable

table?: string

Optionaltoken

token?: string

OptionaltreeSelectReturning

treeSelectReturning?: string

Optionalunsafe

unsafe?: any

OptionalupdateReturning

updateReturning?: string

url

url: ((target: "deeplinks" | "gql") => string)

useCan

useCan: ((objectId: Id | Id[], subjectId: Id | Id[], actionId: Id | Id[]) => {
    data: boolean | void;
    loading: boolean;
    refetch: (() => Promise<boolean>);
})

useDeep

useDeep: (() => DeepClient<Link<Id>>)

useDeepId

useDeepId: ((start: QueryLink | DeepClientStartItem, ...path: DeepClientPathItem[]) => {
    data: Id;
    error?: any;
    loading: boolean;
})

useDeepQuery

useDeepQuery: (<Table, LL>(query: Exp<Table>, options?: Options<Table>) => {
    data?: LL[];
    error?: any;
    loading: boolean;
    refetch?: (() => Promise<any>);
})

useDeepSubscription

useDeepSubscription: (<Table, LL>(query: Exp<Table>, options?: Options<Table>) => UseDeepSubscriptionResult<LL>)

useId

useId: ((start: QueryLink | DeepClientStartItem, ...path: DeepClientPathItem[]) => {
    data: Id;
    error?: any;
    loading: boolean;
})

useLink

useLink: ((link: Id | Link<Id>) => MinilinksLink<Id>)

useLinks

useLinks: ((...links: (Id | Link<Id>)[]) => MinilinksLink<Id>[])

useLocalId

useLocalId: ((start: QueryLink | DeepClientStartItem, ...path: DeepClientPathItem[]) => void | Id)

useLocalQuery

useLocalQuery: ((query: Exp<"links">, options?: MinilinksQueryOptions<MinilinksQueryOptionAggregate>) => L[])

useLocalSubscription

useLocalSubscription: ((query: Exp<"links">, options?: MinilinksQueryOptions<MinilinksQueryOptionAggregate>) => L[])

useMinilinksId

useMinilinksId: ((start: QueryLink | DeepClientStartItem, ...path: DeepClientPathItem[]) => void | Id)

useMinilinksQuery

useMinilinksQuery: ((query: Exp<"links">, options?: MinilinksQueryOptions<MinilinksQueryOptionAggregate>) => L[])

useMinilinksSubscription

useMinilinksSubscription: ((query: Exp<"links">, options?: MinilinksQueryOptions<MinilinksQueryOptionAggregate>) => L[])

useQuery

useQuery: (<Table, LL>(query: Exp<Table>, options?: Options<Table>) => {
    data?: LL[];
    error?: any;
    loading: boolean;
    refetch?: (() => Promise<any>);
})

useSearch

useSearch: ((value: string, options?: DeepSearchOptions) => any)

useSubscription

useSubscription: (<Table, LL>(query: Exp<Table>, options?: Options<Table>) => UseDeepSubscriptionResult<LL>)

OptionalvaluesSelectReturning

valuesSelectReturning?: string

Optionalws

ws?: boolean

Methods

await

can

delete

get

getRemote

guest

id

idLocal

insert

isId

isLink

jwt

login

logout

name

nameLocal

one

Packager

Packages

reserve

search

searchQuery

  • searchQuery(value, options): Exp<"links">

  • Parameters

    • value: string
    • options: {
          contains: boolean;
          db: boolean;
          query: boolean;
          regexp: boolean;
          sort: boolean;
          values: boolean;
      }
      • contains: boolean
      • db: boolean
      • query: boolean
      • regexp: boolean
      • sort: boolean
      • values: boolean

    Returns Exp<"links">

select

serial

serializeQuery

serializeWhere

stringify

subscribe

symbol

symbolLocal

Traveler

unvertualizeId

update

useLocalApply

useMinilinksApply

value

  • value(id, value?): Promise<{
        data: string | number | Object;
        id: Id;
        link?: Link<Id>;
        Value?: Link<Id>;
        [key: string]: any;
    }>

  • Parameters

    • id: Id
    • Optionalvalue: string | number | Object

    Returns Promise<{
        data: string | number | Object;
        id: Id;
        link?: Link<Id>;
        Value?: Link<Id>;
        [key: string]: any;
    }>

Settings

Member Visibility

On This Page

Properties
Methods
MMNEPVFCICPMFPCPTTAAATR