TypeScript API Reference

TypeScript API Reference v0.17.0-rc.4¶

Functions¶

schemaQueryOnly()¶

Create a simple schema configuration with only Query type.

This is a convenience function for schemas that only have queries.

Returns:

A QueryOnlyConfig with default settings

Signature:

function schemaQueryOnly(): QueryOnlyConfig

Example:

const result = schemaQueryOnly();

Returns: QueryOnlyConfig

schemaQueryMutation()¶

Create a schema configuration with Query and Mutation types.

This is a convenience function for schemas with queries and mutations but no subscriptions.

Returns:

A QueryMutationConfig with default settings

Signature:

function schemaQueryMutation(): QueryMutationConfig

Example:

const result = schemaQueryMutation();

Returns: QueryMutationConfig

schemaFull()¶

Create a schema configuration with all three root types.

This is a convenience function for fully-featured schemas.

Returns:

A FullSchemaConfig with default settings

Signature:

function schemaFull(): FullSchemaConfig

Example:

const result = schemaFull();

Returns: FullSchemaConfig

Types¶

ApiKeyConfig¶

API Key authentication configuration

AsyncApiConfig¶

AsyncAPI HTTP endpoint configuration

BackgroundJobMetadata¶

Methods¶

default()¶

Signature:

static default(): BackgroundJobMetadata

Example:

const result = BackgroundJobMetadata.default();

Returns: BackgroundJobMetadata

BackgroundTaskConfig¶

Configuration for in-process background task execution.

Methods¶

default()¶

Signature:

static default(): BackgroundTaskConfig

Example:

const result = BackgroundTaskConfig.default();

Returns: BackgroundTaskConfig

CompressionConfig¶

Compression configuration shared across runtimes

Methods¶

default()¶

Signature:

static default(): CompressionConfig

Example:

const result = CompressionConfig.default();

Returns: CompressionConfig

ContactInfo¶

Contact information

CorsConfig¶

CORS configuration for a route

Methods¶

allowedMethodsJoined()¶

Get the cached joined methods string for preflight responses

Signature:

allowedMethodsJoined(): string

Example:

const result = instance.allowedMethodsJoined();

Returns: string

allowedHeadersJoined()¶

Get the cached joined headers string for preflight responses

Signature:

allowedHeadersJoined(): string

Example:

const result = instance.allowedHeadersJoined();

Returns: string

isOriginAllowed()¶

Check if an origin is allowed (O(1) with wildcard, O(n) for exact match)

Signature:

isOriginAllowed(origin: string): boolean

Example:

const result = instance.isOriginAllowed("value");

Parameters:

Returns: boolean

isMethodAllowed()¶

Check if a method is allowed (O(1) with wildcard, O(n) for exact match)

Signature:

isMethodAllowed(method: string): boolean

Example:

const result = instance.isMethodAllowed("value");

Parameters:

Returns: boolean

default()¶

Signature:

static default(): CorsConfig

Example:

const result = CorsConfig.default();

Returns: CorsConfig

DynamicSchemaConfig¶

Configuration for building and executing a dynamic-SDL schema.

FieldErrorSpec¶

A field-level error to inject at a specific response path.

path is the dot-separated sequence of field names from the operation root to the field that should fail, e.g. "user" for a top-level field or "order.customer" for a nested one.

FullSchemaConfig¶

Configuration for fully-featured schemas with Query, Mutation, and Subscription types

Methods¶

default()¶

Signature:

static default(): FullSchemaConfig

Example:

const result = FullSchemaConfig.default();

Returns: FullSchemaConfig

GraphQlRouteConfig¶

Configuration for GraphQL routes

Provides a builder pattern for configuring GraphQL route parameters for the Spikard HTTP server's routing system.

Methods¶

new()¶

Create a new GraphQL route configuration with defaults

Default values:

• path: "/graphql"
• method: "POST"
• enable_playground: false

Signature:

static new(): GraphQlRouteConfig

Example:

const result = GraphQlRouteConfig.new();

Returns: GraphQlRouteConfig

path()¶

Set the HTTP path for the GraphQL endpoint

Signature:

path(path: string): GraphQlRouteConfig

Example:

const result = instance.path("value");

Parameters:

Returns: GraphQlRouteConfig

method()¶

Set the HTTP method for the GraphQL endpoint

Signature:

method(method: string): GraphQlRouteConfig

Example:

const result = instance.method("value");

Parameters:

Returns: GraphQlRouteConfig

enablePlayground()¶

Enable or disable the GraphQL Playground UI

Signature:

enablePlayground(enable: boolean): GraphQlRouteConfig

Example:

const result = instance.enablePlayground(true);

Parameters:

Returns: GraphQlRouteConfig

description()¶

Set a custom description for documentation

Signature:

description(description: string): GraphQlRouteConfig

Example:

const result = instance.description("value");

Parameters:

Returns: GraphQlRouteConfig

getPath()¶

Get the configured path

Signature:

getPath(): string

Example:

const result = instance.getPath();

Returns: string

getMethod()¶

Get the configured method

Signature:

getMethod(): string

Example:

const result = instance.getMethod();

Returns: string

isPlaygroundEnabled()¶

Check if playground is enabled

Signature:

isPlaygroundEnabled(): boolean

Example:

const result = instance.isPlaygroundEnabled();

Returns: boolean

getDescription()¶

Get the description if set

Signature:

getDescription(): string | null

Example:

const result = instance.getDescription();

Returns: string | null

default()¶

Signature:

static default(): GraphQlRouteConfig

Example:

const result = GraphQlRouteConfig.default();

Returns: GraphQlRouteConfig

GraphQlSubscriptionSnapshot¶

Snapshot of a GraphQL subscription exchange over WebSocket.

GrpcConfig¶

Configuration for gRPC support

Controls how the server handles gRPC requests, including compression, timeouts, and protocol settings.

Stream Limits¶

This configuration enforces message-level size limits but delegates concurrent stream limiting to the HTTP/2 transport layer:

• Message Size Limits: The max_message_size field is enforced per individual message (request or response) in both unary and streaming RPCs. When a single message exceeds this limit, the request is rejected with PAYLOAD_TOO_LARGE (HTTP 413).

• Concurrent Stream Limits: The max_concurrent_streams is an advisory configuration passed to the HTTP/2 layer for connection-level stream negotiation. The HTTP/2 transport automatically enforces this limit and returns GOAWAY frames when exceeded. Applications should not rely on custom enforcement of this limit.

• Stream Response Size Limits: The max_stream_response_bytes field caps the total encoded bytes emitted across a server-streaming or bidi-streaming response. When the cumulative size exceeds the limit, the stream is terminated with tonic.Status.resource_exhausted. Defaults to null (unbounded).

Methods¶

default()¶

Signature:

static default(): GrpcConfig

Example:

const result = GrpcConfig.default();

Returns: GrpcConfig

IntoHandler¶

Convert user-facing handler functions into the low-level Handler trait.

Methods¶

intoHandler()¶

Convert this value into a shared request handler.

Signature:

intoHandler(): Handler

Example:

const result = instance.intoHandler();

Returns: Handler

JsonRpcConfig¶

JSON-RPC server configuration

Methods¶

default()¶

Signature:

static default(): JsonRpcConfig

Example:

const result = JsonRpcConfig.default();

Returns: JsonRpcConfig

JsonRpcMethodInfo¶

JSON-RPC method metadata for routes that support JSON-RPC

This struct captures the metadata needed to expose HTTP routes as JSON-RPC methods, enabling discovery and documentation of RPC-compatible endpoints.

JwtConfig¶

JWT authentication configuration

LicenseInfo¶

License information

OpenApiConfig¶

OpenAPI configuration

Methods¶

default()¶

Signature:

static default(): OpenApiConfig

Example:

const result = OpenApiConfig.default();

Returns: OpenApiConfig

ParseRequest¶

Request body for POST /asyncapi/parse

ParseResult¶

Full parse result returned by POST /asyncapi/parse

ParsedChannel¶

A single channel extracted from an AsyncAPI spec

ParsedMessage¶

A resolved message (name + JSON Schema)

ParsedOperation¶

A single operation extracted from an AsyncAPI spec

ProblemDetails¶

RFC 9457 Problem Details for HTTP APIs

A machine-readable format for specifying errors in HTTP API responses. Per RFC 9457, all fields are optional. The type field defaults to "about:blank" if not specified.

Content-Type¶

Responses using this struct should set:

Content-Type: application/problem+json

{
  "type": "<https://spikard.dev/errors/validation-error",>
  "title": "Request Validation Failed",
  "status": 422,
  "detail": "2 validation errors in request body",
  "errors": [...]
}

Methods¶

withDetail()¶

Set the detail field

Signature:

withDetail(detail: string): ProblemDetails

Example:

const result = instance.withDetail("value");

Parameters:

Returns: ProblemDetails

withInstance()¶

Set the instance field

Signature:

withInstance(instance: string): ProblemDetails

Example:

const result = instance.withInstance("value");

Parameters:

Returns: ProblemDetails

notFound()¶

Create a not found error

Signature:

static notFound(detail: string): ProblemDetails

Example:

const result = ProblemDetails.notFound("value");

Parameters:

Returns: ProblemDetails

methodNotAllowed()¶

Create a method not allowed error

Signature:

static methodNotAllowed(detail: string): ProblemDetails

Example:

const result = ProblemDetails.methodNotAllowed("value");

Parameters:

Returns: ProblemDetails

internalServerError()¶

Create an internal server error

Signature:

static internalServerError(detail: string): ProblemDetails

Example:

const result = ProblemDetails.internalServerError("value");

Parameters:

Returns: ProblemDetails

badRequest()¶

Create a bad request error

Signature:

static badRequest(detail: string): ProblemDetails

Example:

const result = ProblemDetails.badRequest("value");

Parameters:

Returns: ProblemDetails

toJson()¶

Serialize to JSON string

Errors: Returns an error if the serialization fails.

Signature:

toJson(): string

Example:

const result = instance.toJson();

Returns: string

Errors: Throws Error with a descriptive message.

toJsonPretty()¶

Serialize to pretty JSON string

Errors: Returns an error if the serialization fails.

Signature:

toJsonPretty(): string

Example:

const result = instance.toJsonPretty();

Returns: string

Errors: Throws Error with a descriptive message.

QueryMutationConfig¶

Configuration for schemas with Query and Mutation types

Methods¶

default()¶

Signature:

static default(): QueryMutationConfig

Example:

const result = QueryMutationConfig.default();

Returns: QueryMutationConfig

QueryOnlyConfig¶

Configuration for schemas with only Query type

Methods¶

default()¶

Signature:

static default(): QueryOnlyConfig

Example:

const result = QueryOnlyConfig.default();

Returns: QueryOnlyConfig

RateLimitConfig¶

Rate limiting configuration shared across runtimes

Methods¶

default()¶

Signature:

static default(): RateLimitConfig

Example:

const result = RateLimitConfig.default();

Returns: RateLimitConfig

Request¶

Response¶

HTTP Response with custom status code, headers, and content

Methods¶

setHeader()¶

Set a header

Signature:

setHeader(key: string, value: string): void

Example:

instance.setHeader("value", "value");

Parameters:

Returns: No return value.

setCookie()¶

Set a cookie in the response

Signature:

setCookie(key: string, value: string, secure: boolean, httpOnly: boolean, maxAge: number, domain: string, path: string, sameSite: string): void

Example:

instance.setCookie("value", "value", true, true, 42, "value", "value", "value");

Parameters:

Returns: No return value.

default()¶

Signature:

static default(): Response

Example:

const result = Response.default();

Returns: Response

ResponseSnapshot¶

Snapshot of an Axum response used by higher-level language bindings.

Methods¶

text()¶

Return response body as UTF-8 string.

Signature:

text(): string

Example:

const result = instance.text();

Returns: string

Errors: Throws Error with a descriptive message.

header()¶

Lookup header by case-insensitive name.

Signature:

header(name: string): string | null

Example:

const result = instance.header("value");

Parameters:

Returns: string | null

RouteBuilder¶

Builder for defining a route.

Methods¶

new()¶

Create a new builder for the provided HTTP method and path.

Signature:

static new(method: Method, path: string): RouteBuilder

Example:

const result = RouteBuilder.new(new Method(), "value");

Parameters:

Returns: RouteBuilder

handlerName()¶

Assign an explicit handler name.

Signature:

handlerName(name: string): RouteBuilder

Example:

const result = instance.handlerName("value");

Parameters:

Returns: RouteBuilder

requestSchemaJson()¶

Provide a raw JSON schema for the request body.

Signature:

requestSchemaJson(schema: unknown): RouteBuilder

Example:

const result = instance.requestSchemaJson({});

Parameters:

Returns: RouteBuilder

responseSchemaJson()¶

Provide a raw JSON schema for the response body.

Signature:

responseSchemaJson(schema: unknown): RouteBuilder

Example:

const result = instance.responseSchemaJson({});

Parameters:

Returns: RouteBuilder

paramsSchemaJson()¶

Provide a raw JSON schema for request parameters.

Signature:

paramsSchemaJson(schema: unknown): RouteBuilder

Example:

const result = instance.paramsSchemaJson({});

Parameters:

Returns: RouteBuilder

fileParamsJson()¶

Provide multipart file parameter configuration.

Signature:

fileParamsJson(schema: unknown): RouteBuilder

Example:

const result = instance.fileParamsJson({});

Parameters:

Returns: RouteBuilder

cors()¶

Attach a CORS configuration for this route.

Signature:

cors(cors: CorsConfig): RouteBuilder

Example:

const result = instance.cors(new CorsConfig());

Parameters:

Returns: RouteBuilder

compression()¶

Attach a compression configuration for this route.

Signature:

compression(compression: CompressionConfig): RouteBuilder

Example:

const result = instance.compression(new CompressionConfig());

Parameters:

Returns: RouteBuilder

bodyLimit()¶

Attach a per-route maximum request body size in bytes, overriding the server-global default.

Signature:

bodyLimit(maxBytes: number): RouteBuilder

Example:

const result = instance.bodyLimit(42);

Parameters:

Returns: RouteBuilder

requestTimeout()¶

Attach a per-route request timeout in seconds, overriding the server-global default.

Signature:

requestTimeout(seconds: number): RouteBuilder

Example:

const result = instance.requestTimeout(42);

Parameters:

Returns: RouteBuilder

sync()¶

Mark the route as synchronous.

Signature:

sync(): RouteBuilder

Example:

const result = instance.sync();

Returns: RouteBuilder

handlerDependencies()¶

Declare the dependency keys that must be resolved before this handler runs.

Signature:

handlerDependencies(dependencies: Array<string>): RouteBuilder

Example:

const result = instance.handlerDependencies([]);

Parameters:

Returns: RouteBuilder

SchemaConfig¶

Configuration for GraphQL schema building.

Encapsulates all schema-level configuration options including introspection control, complexity limits, and depth limits.

Methods¶

default()¶

Signature:

static default(): SchemaConfig

Example:

const result = SchemaConfig.default();

Returns: SchemaConfig

ServerConfig¶

Server configuration

Methods¶

default()¶

Signature:

static default(): ServerConfig

Example:

const result = ServerConfig.default();

Returns: ServerConfig

ServerInfo¶

Server information

SseEvent¶

An individual SSE event

Represents a single Server-Sent Event to be sent to a connected client. Events can have an optional type, ID, and retry timeout for advanced scenarios.

SSE Format¶

Events are serialized to the following text format:

event: event_type
data: {"json":"value"}
id: event-123
retry: 3000

Methods¶

withId()¶

Set the event ID for client-side reconnection support

Sets an ID that clients can use to resume from this point if they disconnect. The client sends this ID back in the Last-Event-ID header when reconnecting.

Signature:

withId(id: string): SseEvent

Example:

const result = instance.withId("value");

Parameters:

Returns: SseEvent

withRetry()¶

Set the retry timeout for client reconnection

Sets the time in milliseconds clients should wait before attempting to reconnect if the connection is lost. The client browser will automatically handle reconnection.

Signature:

withRetry(retryMs: number): SseEvent

Example:

const result = instance.withRetry(42);

Parameters:

Returns: SseEvent

StaticFilesConfig¶

Static file serving configuration

TestClient¶

Core test client for making HTTP requests to a Spikard application.

This struct wraps axum-test's TestServer and provides a language-agnostic interface for making HTTP requests, sending WebSocket connections, and handling Server-Sent Events. Language bindings wrap this to provide native API surfaces.

Methods¶

graphqlAt()¶

Send a GraphQL query/mutation to a custom endpoint

Signature:

graphqlAt(endpoint: string, query: string, variables: unknown, operationName: string): Promise<ResponseSnapshot>

Example:

const result = await instance.graphqlAt("value", "value", {}, "value");

Parameters:

Returns: ResponseSnapshot

Errors: Throws Error with a descriptive message.

graphql()¶

Send a GraphQL query/mutation

Signature:

graphql(query: string, variables: unknown, operationName: string): Promise<ResponseSnapshot>

Example:

const result = await instance.graphql("value", {}, "value");

Parameters:

Returns: ResponseSnapshot

Errors: Throws Error with a descriptive message.

graphqlSubscriptionAt()¶

Send a GraphQL subscription (WebSocket) to a custom endpoint.

Uses the graphql-transport-ws protocol and captures the first next payload. After the first payload is received, this client sends complete to unsubscribe.

Signature:

graphqlSubscriptionAt(endpoint: string, query: string, variables: unknown, operationName: string): Promise<GraphQlSubscriptionSnapshot>

Example:

const result = await instance.graphqlSubscriptionAt("value", "value", {}, "value");

Parameters:

Returns: GraphQlSubscriptionSnapshot

Errors: Throws Error with a descriptive message.

graphqlSubscription()¶

Send a GraphQL subscription (WebSocket).

Uses /graphql as the default subscription endpoint.

Signature:

graphqlSubscription(query: string, variables: unknown, operationName: string): Promise<GraphQlSubscriptionSnapshot>

Example:

const result = await instance.graphqlSubscription("value", {}, "value");

Parameters:

Returns: GraphQlSubscriptionSnapshot

Errors: Throws Error with a descriptive message.

TestingSseEvent¶

A single Server-Sent Event.

UploadFile¶

Represents an uploaded file from multipart/form-data requests.

This struct provides efficient access to file content with automatic base64 decoding and implements standard I/O traits for compatibility.

Methods¶

asBytes()¶

Get the raw file content as bytes.

This provides zero-copy access to the underlying buffer.

Signature:

asBytes(): Buffer

Example:

const result = instance.asBytes();

Returns: Buffer

readToString()¶

Read the file content as a UTF-8 string.

Errors:

Returns an error if the content is not valid UTF-8.

Signature:

readToString(): string

Example:

const result = instance.readToString();

Returns: string

Errors: Throws Error with a descriptive message.

contentTypeOrDefault()¶

Get the content type, defaulting to "application/octet-stream".

Signature:

contentTypeOrDefault(): string

Example:

const result = instance.contentTypeOrDefault();

Returns: string

ValidateRequest¶

Request body for POST /asyncapi/validate

ValidationResponse¶

Response body for POST /asyncapi/validate

Enums¶

Method¶

HTTP method

SecuritySchemeInfo¶

Security scheme types

SnapshotError¶

Possible errors while converting an Axum response into a snapshot.

WebSocketMessage¶

A WebSocket message that can be text or binary.

Errors¶

AppError¶

Error type for application builder operations.

Errors are thrown as plain Error objects with descriptive messages.

GraphQlError¶

Errors that can occur during GraphQL operations

These errors are compatible with async-graphql error handling and can be converted to structured HTTP responses matching the project's error fixtures.

Errors are thrown as plain Error objects with descriptive messages.

SchemaError¶

Error type for schema building operations

Errors are thrown as plain Error objects with descriptive messages.

Edit this page on GitHub