Class DeepClient<L>

Type Parameters

L = Link<number>

Hierarchy

DeepClient

Implements

DeepClientInstance<L>

Constructors

constructor

new DeepClient<L>(options): DeepClient<L>
Type Parameters
- L = Link<number>
Parameters
- options: DeepClientOptions<L>
Returns DeepClient<L>
- Defined in work/deeplinks/deeplinks/imports/client.tsx:521

Properties

DeepContext

DeepContext: Context<DeepClient<Link<number>>> = DeepContext

DeepProvider

DeepProvider: ((__namedParameters) => Element) = DeepProvider

Type declaration

- (__namedParameters): Element
- Parameters
  - __namedParameters: {
    apolloClient?: IApolloClient<any>;
    children: any;
    }
    - Optional apolloClient?: IApolloClient<any>
    - children: any
  Returns Element

apolloClient

apolloClient: IApolloClient<any>

client

client: IApolloClient<any>

deep

deep: DeepClientInstance<L>

`Optional` defaultDeleteName

defaultDeleteName?: string

`Optional` defaultInsertName

defaultInsertName?: string

`Optional` defaultSelectName

defaultSelectName?: string

`Optional` defaultUpdateName

defaultUpdateName?: string

`Optional` deleteReturning

deleteReturning?: string

`Optional` filesSelectReturning

filesSelectReturning?: string

`Optional` handleAuth

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

Type declaration

- (linkId?, token?): any
- Parameters
  - Optional linkId: number
    Optional
  - Optional token: string
    Optional
  Returns any

`Optional` insertReturning

insertReturning?: string

`Optional` linkId

linkId?: number

`Optional` linksSelectReturning

linksSelectReturning?: string

minilinks

minilinks: MinilinksResult<L>

`Optional` returning

returning?: string

`Optional` selectReturning

selectReturning?: string

`Optional` selectorsSelectReturning

selectorsSelectReturning?: string

serializeQuery

serializeQuery: ((exp, env?) => any) = serializeQuery

Type declaration

- (exp, env?): any
- Parameters
  - exp: any
  - env: string = 'links'
  Returns any

serializeWhere

serializeWhere: ((exp, env?) => any) = serializeWhere

Type declaration

- (exp, env?): any
- Parameters
  - exp: any
  - env: string = 'links'
  Returns any

silent

silent: boolean

`Optional` table

table?: string

`Optional` token

token?: string

`Optional` updateReturning

updateReturning?: string

useDeep

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

Type declaration

- (): DeepClient<Link<number>>
- Returns DeepClient<Link<number>>

useDeepQuery

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

Type declaration

- <Table, LL>(query, options?): {
      data?: LL[];
      error?: any;
      loading: boolean;
  }
- Type Parameters
  - Table extends "objects" | "links" | "numbers" | "strings" | "can" | "selectors" | "tree" | "handlers"
  - LL = Link<number>
  Parameters
  - query: QueryLink
  - Optional options: {
        mini?: string;
        name?: string;
        returning?: string;
        table?: Table;
        variables?: any;
    }
    Optional
    - Optional mini?: string
    - Optional name?: string
    - Optional returning?: string
    - Optional table?: Table
    - Optional variables?: any
  Returns {
      data?: LL[];
      error?: any;
      loading: boolean;
  }
  - Optional data?: LL[]
  - Optional error?: any
  - loading: boolean

useDeepSubscription

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

Type declaration

- <Table, LL>(query, options?): UseDeepSubscriptionResult<LL>
- Type Parameters
  - Table extends "objects" | "links" | "numbers" | "strings" | "can" | "selectors" | "tree" | "handlers"
  - LL = Link<number>
  Parameters
  - query: QueryLink
  - Optional options: {
        mini?: string;
        name?: string;
        returning?: string;
        table?: Table;
        variables?: any;
    }
    Optional
    - Optional mini?: string
    - Optional name?: string
    - Optional returning?: string
    - Optional table?: Table
    - Optional variables?: any
  Returns UseDeepSubscriptionResult<LL>

`Optional` valuesSelectReturning

valuesSelectReturning?: string

`Static` `Optional` resolveDependency

resolveDependency?: ((path) => Promise<any>)

Type declaration

- (path): Promise<any>
- Parameters
  - path: string
  Returns Promise<any>

Methods

_silent

_silent(options?): boolean
Parameters
- options: Partial<{
  silent?: boolean;
  }> = {}
Returns boolean
- Defined in work/deeplinks/deeplinks/imports/client.tsx:517

await

await(id, options?): Promise<any>
Parameters
- id: number
- options: {
  results: boolean;
  } = ...
  - results: boolean
Returns Promise<any>
Implementation of DeepClientInstance.await
- Defined in work/deeplinks/deeplinks/imports/client.tsx:757

can

can(objectIds, subjectIds, actionIds, userIds?): Promise<boolean>
Parameters
- objectIds: number | number[]
- subjectIds: number | number[]
- actionIds: number | number[]
- userIds: number | number[] = ...
Returns Promise<boolean>
Implementation of DeepClientInstance.can
- Defined in work/deeplinks/deeplinks/imports/client.tsx:929

delete

delete<TTable>(exp, options?): Promise<DeepClientResult<{
id: any;
}[]>>
Type Parameters
- TTable extends "objects" | "links" | "numbers" | "strings"
Parameters
- exp: Exp<TTable>
- Optional options: WriteOptions<TTable>
  Optional
Returns Promise<DeepClientResult<{
id: any;
}[]>>
Implementation of DeepClientInstance.delete
- Defined in work/deeplinks/deeplinks/imports/client.tsx:667

guest

guest(options?): Promise<DeepClientAuthResult>
Parameters
- options: DeepClientGuestOptions = {}
Returns Promise<DeepClientAuthResult>
Implementation of DeepClientInstance.guest
- Defined in work/deeplinks/deeplinks/imports/client.tsx:876

id

id(start, ...path): Promise<number>
Find id of link by packageName/id as first argument, and Contain value (name) as path items.
Parameters
- start: QueryLink | DeepClientStartItem
- Rest ...path: DeepClientPathItem[]
  Rest
Returns Promise<number>
number

Description
Thows error if id is not found. You can set last argument true, for disable throwing error.
Implementation of DeepClientInstance.id
- Defined in work/deeplinks/deeplinks/imports/client.tsx:773

idLocal

idLocal(start, ...path): number
Parameters
- start: DeepClientStartItem
- Rest ...path: DeepClientPathItem[]
  Rest
Returns number
Implementation of DeepClientInstance.idLocal
- Defined in work/deeplinks/deeplinks/imports/client.tsx:842

ids

ids(...paths): Promise<any>
This function fetches the corresponding IDs from the Deep for each specified path.
Parameters
- Rest ...paths: [DeepClientStartItem, ...DeepClientPathItem[]][]
  
  An array of [start, ...path] tuples. Each tuple specifies a path to a link, where 'start' is the package name or id and ...path further specifies the path to the id using Contain link values (names).
  
  Rest
Returns Promise<any>
- Returns a Promise that resolves to an object. The object has keys corresponding to the package name or id of each path. The value for each package key is an object where keys are the items in the corresponding path, and the values are the IDs retrieved from the Deep.
Async

Function
ids

Throws
Will throw an error if the id retrieval fails in this.id() function.

Example
```
  const ids = await deep.ids([
    ['@deep-foundation/core', 'Package'], 
    ['@deep-foundation/core', 'PackageVersion']
  ]);

  // Outputs
  // {
  //   "@deep-foundation/core": {
  //     "Package": 2,
  //     "PackageVersion": 46
  //   }
  // }
```
- Defined in work/deeplinks/deeplinks/imports/client.tsx:824

import

import(path): Promise<any>
Parameters
- path: string
Returns Promise<any>
- Defined in work/deeplinks/deeplinks/imports/client.tsx:957

insert

insert<TTable, LL>(objects, options?): Promise<DeepClientResult<{
id: any;
}[]>>
Type Parameters
- TTable extends "objects" | "links" | "numbers" | "strings"
- LL = L
Parameters
- objects: InsertObjects<TTable>
- Optional options: WriteOptions<TTable>
  Optional
Returns Promise<DeepClientResult<{
id: any;
}[]>>
Implementation of DeepClientInstance.insert
- Defined in work/deeplinks/deeplinks/imports/client.tsx:616

name

name(input): Promise<string>
Parameters
- input: number | Link<number>
Returns Promise<string>
- Defined in work/deeplinks/deeplinks/imports/client.tsx:939

nameLocal

nameLocal(input): string
Parameters
- input: number | Link<number>
Returns string
- Defined in work/deeplinks/deeplinks/imports/client.tsx:950

reserve

reserve<LL>(count): Promise<number[]>
Type Parameters
- LL = L
Parameters
- count: number
Returns Promise<number[]>
Implementation of DeepClientInstance.reserve
- Defined in work/deeplinks/deeplinks/imports/client.tsx:753

select

select<TTable, LL>(exp, options?): Promise<DeepClientResult<LL[]>>
Type Parameters
- TTable extends "objects" | "links" | "numbers" | "strings" | "can" | "selectors" | "tree" | "handlers"
- LL = L
Parameters
- exp: Exp<TTable>
- Optional options: ReadOptions<TTable>
  Optional
Returns Promise<DeepClientResult<LL[]>>
Implementation of DeepClientInstance.select
- Defined in work/deeplinks/deeplinks/imports/client.tsx:580

serial

serial(__namedParameters): Promise<DeepClientResult<{
id: number;
}[]>>
Parameters
- __namedParameters: AsyncSerialParams
Returns Promise<DeepClientResult<{
id: number;
}[]>>
Implementation of DeepClientInstance.serial
- Defined in work/deeplinks/deeplinks/imports/client.tsx:690

stringify

stringify(any?): string
Parameters
- Optional any: any
  Optional
Returns string
Implementation of DeepClientInstance.stringify
- Defined in work/deeplinks/deeplinks/imports/client.tsx:566

update

update<TTable>(exp, value, options?): Promise<DeepClientResult<{
id: any;
}[]>>
Type Parameters
- TTable extends "objects" | "links" | "numbers" | "strings"
Parameters
- exp: Exp<TTable>
- value: UpdateValue<TTable>
- Optional options: WriteOptions<TTable>
  Optional
Returns Promise<DeepClientResult<{
id: any;
}[]>>
Implementation of DeepClientInstance.update
- Defined in work/deeplinks/deeplinks/imports/client.tsx:642

useMinilinksQuery

useMinilinksQuery(query): any
Parameters
- query: QueryLink
Returns any
- Defined in work/deeplinks/deeplinks/imports/client.tsx:484

useMinilinksSubscription

useMinilinksSubscription(query): any
Parameters
- query: QueryLink
Returns any
- Defined in work/deeplinks/deeplinks/imports/client.tsx:485

whoami

whoami(): Promise<number>
Return is of current authorized user linkId. Refill client.linkId and return.

Returns Promise<number>
- Defined in work/deeplinks/deeplinks/imports/client.tsx:914

Class DeepClient<L>

Type Parameters

L = Link<number>

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

L = Link<number>

Parameters

options: DeepClientOptions<L>

Returns DeepClient<L>

Properties

DeepContext

DeepProvider

Type declaration

Parameters

__namedParameters: { apolloClient?: IApolloClient<any>; children: any; }

Optional apolloClient?: IApolloClient<any>

children: any

Returns Element

apolloClient

client

deep

Optional defaultDeleteName

Optional defaultInsertName

Optional defaultSelectName

Optional defaultUpdateName

Optional deleteReturning

Optional filesSelectReturning

Optional handleAuth

Type declaration

Parameters

Optional linkId: number

Optional token: string

Returns any

Optional insertReturning

Optional linkId

Optional linksSelectReturning

minilinks

Optional returning

Optional selectReturning

Optional selectorsSelectReturning

serializeQuery

Type declaration

Parameters

exp: any

env: string = 'links'

Returns any

serializeWhere

Type declaration

Parameters

exp: any

env: string = 'links'

Returns any

silent

Optional table

Optional token

Optional updateReturning

useDeep

Type declaration

Returns DeepClient<Link<number>>

useDeepQuery

Type declaration

Type Parameters

Table extends "objects" | "links" | "numbers" | "strings" | "can" | "selectors" | "tree" | "handlers"

LL = Link<number>

Parameters

query: QueryLink

Optional options: { mini?: string; name?: string; returning?: string; table?: Table; variables?: any; }

Optional mini?: string

Optional name?: string

Optional returning?: string

Optional table?: Table

Optional variables?: any

Returns { data?: LL[]; error?: any; loading: boolean; }

__namedParameters: {
apolloClient?: IApolloClient<any>;
children: any;
}

`Optional` apolloClient?: IApolloClient<any>

`Optional` defaultDeleteName

`Optional` defaultInsertName

`Optional` defaultSelectName

`Optional` defaultUpdateName

`Optional` deleteReturning

`Optional` filesSelectReturning

`Optional` handleAuth

`Optional` linkId: number

`Optional` token: string

`Optional` insertReturning

`Optional` linkId

`Optional` linksSelectReturning

`Optional` returning

`Optional` selectReturning

`Optional` selectorsSelectReturning

`Optional` table

`Optional` token

`Optional` updateReturning

`Optional` options: {
mini?: string;
name?: string;
returning?: string;
table?: Table;
variables?: any;
}

`Optional` mini?: string

`Optional` name?: string

`Optional` returning?: string

`Optional` table?: Table

`Optional` variables?: any

Returns {
data?: LL[];
error?: any;
loading: boolean;
}

`Optional` data?: LL[]

`Optional` error?: any

`Optional` options: {
mini?: string;
name?: string;
returning?: string;
table?: Table;
variables?: any;
}

`Optional` mini?: string

`Optional` name?: string

`Optional` returning?: string

`Optional` table?: Table

`Optional` variables?: any

`Optional` valuesSelectReturning

`Static` `Optional` resolveDependency

options: Partial<{
silent?: boolean;
}> = {}

options: {
results: boolean;
} = ...

`Optional` options: WriteOptions<TTable>

Returns Promise<DeepClientResult<{
id: any;
}[]>>

`Rest` ...path: DeepClientPathItem[]

`Rest` ...path: DeepClientPathItem[]

`Rest` ...paths: [DeepClientStartItem, ...DeepClientPathItem[]][]