Skip to main content

WeaveClient

weave • Docs

weave / WeaveClient

Class: WeaveClient

Constructors​

new WeaveClient()​

new WeaveClient(traceServerApi, wandbServerApi, projectId, settings): WeaveClient

Parameters​

• traceServerApi: Api<any>

• wandbServerApi: WandbServerApi

• projectId: string

• settings: Settings = ...

Returns​

WeaveClient

Defined in​

weaveClient.ts:82

Properties​

projectId​

projectId: string

Defined in​

weaveClient.ts:85

settings​

settings: Settings

Defined in​

weaveClient.ts:86

traceServerApi​

traceServerApi: Api<any>

Defined in​

weaveClient.ts:83

Methods​

createCall()​

createCall(opRef, params, parameterNames, thisArg, currentCall, parentCall, startTime, displayName?): Promise<void>

Parameters​

• opRef: any

• params: any[]

• parameterNames: ParameterNamesOption

• thisArg: any

• currentCall: CallStackEntry

• parentCall: undefined | CallStackEntry

• startTime: Date

• displayName?: string

Returns​

Promise<void>

Defined in​

weaveClient.ts:610

finishCall()​

finishCall(result, currentCall, parentCall, summarize, endTime, startCallPromise): Promise<void>

Parameters​

• result: any

• currentCall: CallStackEntry

• parentCall: undefined | CallStackEntry

• summarize: undefined | (result) => Record<string, any>

• endTime: Date

• startCallPromise: Promise<void>

Returns​

Promise<void>

Defined in​

weaveClient.ts:648

finishCallWithException()​

finishCallWithException(error, currentCall, parentCall, endTime, startCallPromise): Promise<void>

Parameters​

• error: any

• currentCall: CallStackEntry

• parentCall: undefined | CallStackEntry

• endTime: Date

• startCallPromise: Promise<void>

Returns​

Promise<void>

Defined in​

weaveClient.ts:677

get()​

get(ref): Promise<any>

Parameters​

• ref: ObjectRef

Returns​

Promise<any>

Defined in​

weaveClient.ts:229

getCalls()​

getCalls(filter, includeCosts, limit): Promise<CallSchema[]>

Parameters​

• filter: CallsFilter = {}

• includeCosts: boolean = false

• limit: number = 1000

Returns​

Promise<CallSchema[]>

Defined in​

weaveClient.ts:172

getCallsIterator()​

getCallsIterator(filter, includeCosts, limit): AsyncIterableIterator<CallSchema>

Parameters​

• filter: CallsFilter = {}

• includeCosts: boolean = false

• limit: number = 1000

Returns​

AsyncIterableIterator<CallSchema>

Defined in​

weaveClient.ts:184

getCallStack()​

getCallStack(): CallStack

Returns​

CallStack

Defined in​

weaveClient.ts:537

publish()​

publish(obj, objId?): Promise<ObjectRef>

Parameters​

• obj: any

• objId?: string

Returns​

Promise<ObjectRef>

Defined in​

weaveClient.ts:160

pushNewCall()​

pushNewCall(): object

Returns​

object

currentCall​

currentCall: CallStackEntry

newStack​

newStack: CallStack

parentCall?​

optional parentCall: CallStackEntry

Defined in​

weaveClient.ts:541

runWithCallStack()​

runWithCallStack<T>(callStack, fn): T

Type Parameters​

• T

Parameters​

• callStack: CallStack

• fn

Returns​

T

Defined in​

weaveClient.ts:545

saveOp()​

saveOp(op, objId?): Promise<any>

Parameters​

• op: Op<(...args) => any>

• objId?: string

Returns​

Promise<any>

Defined in​

weaveClient.ts:575

waitForBatchProcessing()​

waitForBatchProcessing(): Promise<void>

Returns​

Promise<void>

Defined in​

weaveClient.ts:103