@pbvex/client / PBVexClient

Class: PBVexClient

Extends

• Client

Constructors

Constructor

new PBVexClient(url, options?): PBVexClient

Parameters

url

string | URL

options?

ClientOptions = {}

Returns

PBVexClient

Inherited from

Client.constructor

Properties

auth

readonly auth: AuthClient

Inherited from

Client.auth

---

authStore

readonly authStore: AuthStore

Inherited from

Client.authStore

Accessors

connectionState

Get Signature

get connectionState(): ConnectionState

Returns

ConnectionState

Inherited from

Client.connectionState

Methods

action()

Call Signature

action<Ref>(ref, ...argsAndOptions): Promise<FunctionReturnType<Ref>>

Type Parameters

Ref

Ref extends FunctionReference<"action", any, any, "public">

Parameters

ref

Ref

argsAndOptions

...ArgsAndOptions<Ref, CallOptions>

Returns

Promise<FunctionReturnType<Ref>>

Inherited from

Client.action

Call Signature

action<Args, Return>(name, args?, options?): Promise<Return>

Type Parameters

Args

Args = any

Return

Return = any

Parameters

name

string

args?

Args

options?

CallOptions

Returns

Promise<Return>

Inherited from

Client.action

---

clearAuth()

clearAuth(): void

Returns

void

Inherited from

Client.clearAuth

---

close()

close(): void

Returns

void

Inherited from

Client.close

---

mutation()

Call Signature

mutation<Ref>(ref, ...argsAndOptions): Promise<FunctionReturnType<Ref>>

Type Parameters

Ref

Ref extends FunctionReference<"mutation", any, any, "public">

Parameters

ref

Ref

argsAndOptions

...ArgsAndOptions<Ref, CallOptions>

Returns

Promise<FunctionReturnType<Ref>>

Inherited from

Client.mutation

Call Signature

mutation<Args, Return>(name, args?, options?): Promise<Return>

Type Parameters

Args

Args = any

Return

Return = any

Parameters

name

string

args?

Args

options?

CallOptions

Returns

Promise<Return>

Inherited from

Client.mutation

---

query()

Call Signature

query<Ref>(ref, ...argsAndOptions): Promise<FunctionReturnType<Ref>>

Type Parameters

Ref

Ref extends FunctionReference<"query", any, any, "public">

Parameters

ref

Ref

argsAndOptions

...ArgsAndOptions<Ref, CallOptions>

Returns

Promise<FunctionReturnType<Ref>>

Inherited from

Client.query

Call Signature

query<Args, Return>(name, args?, options?): Promise<Return>

Type Parameters

Args

Args = any

Return

Return = any

Parameters

name

string

args?

Args

options?

CallOptions

Returns

Promise<Return>

Inherited from

Client.query

---

resolveAuth()

resolveAuth(authOverride?): Promise<string | undefined>

Parameters

authOverride?

string | AuthProvider

Returns

Promise<string | undefined>

Inherited from

Client.resolveAuth

---

setAuth()

setAuth(value): void

Parameters

value

string | AuthProvider

Returns

void

Inherited from

Client.setAuth

---

watch()

Call Signature

watch<Ref>(ref, ...argsAndOptions): Unsubscribe

Type Parameters

Ref

Ref extends FunctionReference<"query", any, any, "public">

Parameters

ref

Ref

argsAndOptions

...ArgsAndOptions<Ref, WatchOptions<FunctionReturnType<Ref>>>

Returns

Unsubscribe

Inherited from

Client.watch

Call Signature

watch<Return>(name, args?, options?): Unsubscribe

Type Parameters

Return

Return = any

Parameters

name

string

args?

unknown

options?

WatchOptions<Return>

Returns

Unsubscribe

Inherited from

Client.watch