Interface DeepClientInstance<L>

Type Parameters

L = Link<number>

Hierarchy

DeepClientInstance

Implemented by

DeepClient

Properties

apolloClient

apolloClient: 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

`Optional` table

table?: string

`Optional` token

token?: string

`Optional` updateReturning

updateReturning?: string

useDeepSubscription

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

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

Methods

await

await(id): Promise<boolean>
Parameters
- id: number
Returns Promise<boolean>
- Defined in work/deeplinks/deeplinks/imports/client.tsx:352

can

can(objectIds, subjectIds, actionIds): Promise<boolean>
Parameters
- objectIds: number[]
- subjectIds: number[]
- actionIds: number[]
Returns Promise<boolean>
- Defined in work/deeplinks/deeplinks/imports/client.tsx:369

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;
}[]>>
- Defined in work/deeplinks/deeplinks/imports/client.tsx:346

guest

guest(options): Promise<DeepClientAuthResult>
Parameters
- options: DeepClientGuestOptions
Returns Promise<DeepClientAuthResult>
- Defined in work/deeplinks/deeplinks/imports/client.tsx:361

id

id(start, ...path): Promise<number>
Parameters
- start: QueryLink | DeepClientStartItem
- Rest ...path: DeepClientPathItem[]
  Rest
Returns Promise<number>
- Defined in work/deeplinks/deeplinks/imports/client.tsx:358

idLocal

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

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;
}[]>>
- Defined in work/deeplinks/deeplinks/imports/client.tsx:342

reserve

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

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[]>>
- Defined in work/deeplinks/deeplinks/imports/client.tsx:340

serial

serial(options): Promise<DeepClientResult<{
id: any;
}[]>>
Parameters
- options: AsyncSerialParams
Returns Promise<DeepClientResult<{
id: any;
}[]>>
- Defined in work/deeplinks/deeplinks/imports/client.tsx:348

serializeQuery

serializeQuery(exp, env?): any
Parameters
- exp: any
- Optional env: string
  Optional
Returns any
- Defined in work/deeplinks/deeplinks/imports/client.tsx:356

serializeWhere

serializeWhere(exp, env?): any
Parameters
- exp: any
- Optional env: string
  Optional
Returns any
- Defined in work/deeplinks/deeplinks/imports/client.tsx:355

stringify

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

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;
}[]>>
- Defined in work/deeplinks/deeplinks/imports/client.tsx:344

Interface DeepClientInstance<L>

Type Parameters

L = Link<number>

Hierarchy

Implemented by

Index

Properties

Methods

Properties

apolloClient

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

Optional table

Optional token

Optional updateReturning

useDeepSubscription

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 UseDeepSubscriptionResult<LL>

Optional valuesSelectReturning

Methods

await

Parameters

id: number

Returns Promise<boolean>

can

Parameters

objectIds: number[]

subjectIds: number[]

actionIds: number[]

Returns Promise<boolean>

delete

Type Parameters

TTable extends "objects" | "links" | "numbers" | "strings"

Parameters

exp: Exp<TTable>

Optional options: WriteOptions<TTable>

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

guest

Parameters

options: DeepClientGuestOptions

Returns Promise<DeepClientAuthResult>

id

Parameters

start: QueryLink | DeepClientStartItem

Rest ...path: DeepClientPathItem[]

Returns Promise<number>

idLocal

Parameters

start: DeepClientStartItem

Rest ...path: DeepClientPathItem[]

Returns number

`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

`Optional` valuesSelectReturning

`Optional` options: WriteOptions<TTable>

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

`Rest` ...path: DeepClientPathItem[]

`Rest` ...path: DeepClientPathItem[]

`Optional` options: WriteOptions<TTable>

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

`Optional` options: ReadOptions<TTable>

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

`Optional` env: string

`Optional` env: string

`Optional` any: any

`Optional` options: WriteOptions<TTable>

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