Interface: Transport<Mutations>

Defined in: fate/src/transport.ts:55

Contract the fate client expects from a network transport. The transport is responsible for fetching records by ID, fetching lists, and executing mutations with the provided selections.

Type Parameters

Mutations

Mutations extends TransportMutations = EmptyTransportMutations

Properties

separateMutationSelectionArgs?

optional separateMutationSelectionArgs?: boolean

Defined in: fate/src/transport.ts:96

Receive mutation selection arguments separately from the mutation input.

---

supportsAliases?

optional supportsAliases?: boolean

Defined in: fate/src/transport.ts:113

Accept resultName:schemaField selection paths and return records with those encoded keys.

Methods

fetchById()

fetchById(type, ids, select, args?, context?): Promise<unknown[]>

Defined in: fate/src/transport.ts:56

Parameters

type

string

ids

(string | number)[]

select

Iterable<string>

args?

FateRecord

context?

Readonly<{ refetch?: string; signal?: AbortSignal; }>

Returns

Promise<unknown[]>

---

fetchList()?

optional fetchList(proc, select, args?, context?): Promise<{ items: object[]; pagination: Pagination; } | null>

Defined in: fate/src/transport.ts:63

Parameters

proc

string

select

Iterable<string>

args?

FateRecord

context?

Readonly<{ refetch?: string; signal?: AbortSignal; }>

Returns

Promise<{ items: object[]; pagination: Pagination; } | null>

---

fetchQuery()?

optional fetchQuery(proc, select, args?, context?): Promise<unknown>

Defined in: fate/src/transport.ts:72

Parameters

proc

string

select

Iterable<string>

args?

FateRecord

context?

Readonly<{ refetch?: string; signal?: AbortSignal; }>

Returns

Promise<unknown>

---

mutate()?

optional mutate<K>(proc, input, select, selectionArgs?): Promise<Mutations[K]["output"]>

Defined in: fate/src/transport.ts:78

Type Parameters

K

K extends string

Parameters

proc

K

input

Mutations[K]["input"]

select

Set<string>

selectionArgs?

FateRecord

Returns

Promise<Mutations[K]["output"]>

---

mutateDurably()?

optional mutateDurably<K>(proc, input, select, identity, selectionArgs?): Promise<Mutations[K]["output"]>

Defined in: fate/src/transport.ts:88

Deliver through an endpoint that durably deduplicates this identity. Required for persisted mutations; never falls back to ordinary mutate.

Type Parameters

K

K extends string

Parameters

proc

K

input

Mutations[K]["input"]

select

Set<string>

identity

MutationIdentity

selectionArgs?

FateRecord

Returns

Promise<Mutations[K]["output"]>

---

subscribeById()?

optional subscribeById(type, id, select, args, handlers): () => void

Defined in: fate/src/transport.ts:97

Parameters

type

string

id

string | number

select

Iterable<string>

args

FateRecord | undefined

handlers

LiveEventHandlers

Returns

() => void

---

subscribeConnection()?

optional subscribeConnection(procedure, type, args, select, selectionArgs, handlers): () => void

Defined in: fate/src/transport.ts:104

Parameters

procedure

string

type

string

args

FateRecord | undefined

select

Iterable<string>

selectionArgs

FateRecord | undefined

handlers

LiveConnectionEventHandlers

Returns

() => void