Look up SDK definition APIs, application client configuration, and typed execution results.
API Reference
Results: 165
- createClient @defjs/core · Function
- withEndpoint @defjs/core · Function
- withInterceptors @defjs/core · Function
- withQuerySerializer @defjs/core · Function
- withHTTPHandle @defjs/core · Function
- withSSEHandle @defjs/core · Function
- withWebSocketHandle @defjs/core · Function
- withCredentials @defjs/core · Function
- withXSRF @defjs/core · Function
- withSSEReconnect @defjs/core · Function
- withSSEOnInvalidEvent @defjs/core · Function
- withWebSocketBeforeConnect @defjs/core · Function
- withWebSocketProtocols @defjs/core · Function
- withWebSocketHeartbeat @defjs/core · Function
- withWebSocketReconnect @defjs/core · Function
- Client @defjs/core · Type
- RequestOptions @defjs/core · Type
- ClientOption @defjs/core · Type
- ClientOptions @defjs/core · Type
- ClientConfig @defjs/core · Type
- ClientSSEOptions @defjs/core · Type
- ClientSSEConfig @defjs/core · Type
- ClientWebSocketOptions @defjs/core · Type
- QuerySerializer @defjs/core · Type
- WebSocketHandle @defjs/core · Type
- WebSocketHandleConstructor @defjs/core · Type
- defineRequest @defjs/core · Function
- fetchHandler @defjs/core · Function
- makeResponse @defjs/core · Function
- RequestDefinition @defjs/core · Type
- RequestEndpoint @defjs/core · Type
- BuilderInput @defjs/core · Type
- HttpRequestShape @defjs/core · Type
- HttpExecuteOptions @defjs/core · Type
- UseRequestConfig @defjs/core · Type
- HttpAwaitResult @defjs/core · Type
- RequestSuccessData @defjs/core · Type
- RequestErrorData @defjs/core · Type
- HttpRequest @defjs/core · Type
- HttpMeta @defjs/core · Type
- DecodedResponse @defjs/core · Type
- HttpResponse @defjs/core · Type
- HttpResponseType @defjs/core · Type
- HttpProgressEvent @defjs/core · Type
- HttpProgressFn @defjs/core · Type
- MakeResponseOptions @defjs/core · Type
- struct @defjs/core · Constant
- struct.any @defjs/core · Function
- struct.array @defjs/core · Function
- struct.arrayBuffer @defjs/core · Function
- struct.bigint @defjs/core · Function
- struct.blob @defjs/core · Function
- struct.boolean @defjs/core · Function
- struct.date @defjs/core · Function
- struct.discriminatedUnion @defjs/core · Function
- struct.enum @defjs/core · Function
- struct.file @defjs/core · Function
- struct.formData @defjs/core · Function
- struct.intersection @defjs/core · Function
- struct.literal @defjs/core · Function
- struct.null @defjs/core · Function
- struct.number @defjs/core · Function
- struct.object @defjs/core · Function
- struct.or @defjs/core · Function
- struct.parse @defjs/core · Function
- struct.record @defjs/core · Function
- struct.string @defjs/core · Function
- struct.tuple @defjs/core · Function
- struct.unknown @defjs/core · Function
- struct.urlencoded @defjs/core · Function
- Infer @defjs/core · Type
- StructInput @defjs/core · Type
- AnyStruct @defjs/core · Type
- Struct @defjs/core · Type
- StructLike @defjs/core · Type
- StructMethods @defjs/core · Type
- ObjectStruct @defjs/core · Type
- ParseResult @defjs/core · Type
- ErrorMap @defjs/core · Type
- StructError @defjs/core · Type
- StructIssue @defjs/core · Type
- FormattedStructError @defjs/core · Type
- FlattenedStructError @defjs/core · Type
- FaultCode @defjs/core · Type
- FaultClass @defjs/core · Type
- Fault @defjs/core · Type
- FaultOf @defjs/core · Type
- HttpStatusFault @defjs/core · Type
- HttpStatusFaultOf @defjs/core · Type
- DecodeFault @defjs/core · Type
- PreflightFault @defjs/core · Type
- AnyFault @defjs/core · Type
- createHttpStatusFault @defjs/core · Function
- createUndecodedHttpStatusFault @defjs/core · Function
- createDecodeFault @defjs/core · Function
- createNetworkFault @defjs/core · Function
- createPreflightFault @defjs/core · Function
- ERR_ABORTED @defjs/core · Constant
- ERR_TIMEOUT @defjs/core · Constant
- isAbortCause @defjs/core · Function
- isTimeoutCause @defjs/core · Function
- createHttpInterceptor @defjs/core · Function
- createSSEInterceptor @defjs/core · Function
- createWebSocketInterceptor @defjs/core · Function
- basicAuthHttpInterceptor @defjs/core · Function
- basicAuthSSEInterceptor @defjs/core · Function
- Interceptor @defjs/core · Type
- InterceptorFn @defjs/core · Type
- HttpInterceptor @defjs/core · Type
- HttpInterceptorNext @defjs/core · Type
- SSEInterceptor @defjs/core · Type
- SSEInterceptorFn @defjs/core · Type
- SSEHandler @defjs/core · Type
- WebSocketInterceptor @defjs/core · Type
- WebSocketInterceptorFn @defjs/core · Type
- WebSocketHandler @defjs/core · Type
- WebSocketSessionLike @defjs/core · Type
- BasicAuthInterceptorOptions @defjs/core · Type
- defineEventStream @defjs/core · Function
- EventStreamDefinition @defjs/core · Type
- EventStreamEndpoint @defjs/core · Type
- EventStreamRequestShape @defjs/core · Type
- EventStreamExecuteOptions @defjs/core · Type
- StreamAwaitResult @defjs/core · Type
- EventStreamHandle @defjs/core · Type
- EventStreamOpenInfo @defjs/core · Type
- EventStreamCloseInfo @defjs/core · Type
- EventStructs @defjs/core · Type
- EventStreamData @defjs/core · Type
- defineWebSocket @defjs/core · Function
- WebSocketDefinition @defjs/core · Type
- WebSocketEndpoint @defjs/core · Type
- WebSocketRequestShape @defjs/core · Type
- WebSocketExecuteOptions @defjs/core · Type
- UseWebSocketConfig @defjs/core · Type
- SocketAwaitResult @defjs/core · Type
- WebSocketSession @defjs/core · Type
- WebSocketState @defjs/core · Type
- WebSocketConnectionInfo @defjs/core · Type
- WebSocketCloseInfo @defjs/core · Type
- ManualSocketCloseReason @defjs/core · Type
- WebSocketHeartbeatConfig @defjs/core · Type
- WebSocketIncomingData @defjs/core · Type
- WebSocketOutgoingData @defjs/core · Type
- SocketLifecycleOutcome @defjs/core · Type
- createClientPlugin @defjs/vue · Function
- injectClient @defjs/vue · Function
- HTTP_CLIENT @defjs/vue · Constant
- ClientProvider @defjs/react · Function
- useClient @defjs/react · Function
- ClientProviderProps @defjs/react · Type
- withOpenTelemetryServer @defjs/opentelemetry-server · Function
- OpenTelemetryServerOptions @defjs/opentelemetry-server · Type
- OpenTelemetryServerTransportOptions @defjs/opentelemetry-server · Type
- OpenTelemetryServerHttpOptions @defjs/opentelemetry-server · Type
- OpenTelemetryServerSSEOptions @defjs/opentelemetry-server · Type
- OpenTelemetryServerWebSocketOptions @defjs/opentelemetry-server · Type
- FetchHandle @defjs/core · Type
- withHeaders @defjs/core · Function
- DecodeFaultCode @defjs/core · Type
- PreflightFaultCode @defjs/core · Type
- createResolvedRequestUrl @defjs/core · Function
- EventStreamFaultCode @defjs/core · Type
- STRUCT @defjs/core · Type
- DerivableClient @defjs/core · Type
Use this reference while building or consuming a Defjs SDK. SDK authors start with defineRequest, defineEventStream, defineWebSocket, and Structs. Applications use Client configuration to call those operations and Errors to handle results.
Signatures are the contract. Follow the quick start and SDK publishing guide for the complete workflow.
Packages
| Package | What you look up |
|---|---|
@defjs/core | createClient, defineRequest, struct, HTTP / SSE / WebSocket |
@defjs/vue | createClientPlugin, injectClient, HTTP_CLIENT |
@defjs/react | ClientProvider, useClient |
@defjs/opentelemetry-server | withOpenTelemetryServer, per-transport options |
@defjs/core
| Page | What you look up |
|---|---|
| Client | createClient, with* options, Client |
| HTTP | defineRequest, HttpExecuteOptions, HttpRequest / HttpResponse |
| Struct | struct.*, Infer, StructError |
| Errors | Fault variants and factories |
| Interceptors | HTTP / SSE / WebSocket interceptor helpers |
| SSE | defineEventStream, stream handle |
| WebSocket | defineWebSocket, session |