Class: PrefactorClient\<TMiddleware\>
Prefactor TypeScript SDK / @prefactor/core / PrefactorClient
Class: PrefactorClient<TMiddleware>
Section titled “Class: PrefactorClient<TMiddleware>”Defined in: packages/core/src/client.ts:72
Type Parameters
Section titled “Type Parameters”TMiddleware
Section titled “TMiddleware”TMiddleware = MiddlewareLike
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new PrefactorClient<
TMiddleware>(core,middleware,provider):PrefactorClient<TMiddleware>
Defined in: packages/core/src/client.ts:84
Creates a Prefactor client bound to a runtime and provider middleware.
Parameters
Section titled “Parameters”Initialized core runtime.
middleware
Section titled “middleware”TMiddleware
Provider middleware returned by the integration.
provider
Section titled “provider”PrefactorProvider<TMiddleware>
Provider used to construct the client.
Returns
Section titled “Returns”PrefactorClient<TMiddleware>
Methods
Section titled “Methods”getTracer()
Section titled “getTracer()”getTracer():
Tracer
Defined in: packages/core/src/client.ts:99
Returns the runtime tracer used by this client.
Returns
Section titled “Returns”Active tracer instance.
getMiddleware()
Section titled “getMiddleware()”getMiddleware():
TMiddleware
Defined in: packages/core/src/client.ts:108
Returns provider middleware created during initialization.
Returns
Section titled “Returns”TMiddleware
Provider middleware object.
withSpan()
Section titled “withSpan()”withSpan<
T>(options,fn):Promise<T>
Defined in: packages/core/src/client.ts:119
Runs a function within a manually-created span.
Type Parameters
Section titled “Type Parameters”T
Parameters
Section titled “Parameters”options
Section titled “options”Manual span options.
() => T | Promise<T>
Function executed inside the created span.
Returns
Section titled “Returns”Promise<T>
Result of fn as a promise.
shutdown()
Section titled “shutdown()”shutdown():
Promise<void>
Defined in: packages/core/src/client.ts:139
Flushes pending telemetry and releases the global singleton reference.
The global client reference is always cleared, even if shutdown fails.
Returns
Section titled “Returns”Promise<void>
Promise that resolves when shutdown completes.