inngest/index.d.ts

Official SDK for Inngest.com. Inngest is the reliability layer for modern applications. Inngest combines durable execution, events, and queues into a zero-infra platform with built-in observability.

/**
 * The primary entrypoint for the Inngest SDK. This provides all the necessary
 * exports to create, run, and trigger Inngest functions.
 *
 * Typical usage involves creating a new Inngest client with `Inngest`, and then
 * using the client to create functions, middleware, and other tools.
 *
 * See {@link https://www.inngest.com/docs} for more information.
 *
 * @example Create an Inngest client
 * ```ts
 * const inngest = new Inngest({
 *   id: "my-app-id",
 * });
 * ```
 *
 * @example Create an Inngest function
 * ```ts
 * const myFn = inngest.createFunction({
 *  id: "my-function",
 * }, {
 *   event: "user/created",
 * }, async ({ event, step }) => {
 *   console.log("User created:", event.data);
 * });
 * ```
 *
 * @example Send an event
 * ```ts
 * await inngest.send({
 *   name: "user/created",
 *   data: {
 *     id: "123",
 *   },
 * });
 * ```
 *
 * @module
 */
export * from "@inngest/ai";
export { EventSchemas, type AddName, type AssertInternalEventPayloads, type Combine, type LiteralZodEventSchema, type StandardEventSchemas, type StandardEventSchemaToPayload, type ZodEventSchemas, } from "./components/EventSchemas.js";
export { fetch } from "./components/Fetch.js";
export type { ClientOptionsFromInngest, EventsFromOpts, GetEvents, GetFunctionInput, GetFunctionOutput, GetStepTools, } from "./components/Inngest";
export { Inngest } from "./components/Inngest.js";
export type { ServeHandlerOptions } from "./components/InngestCommHandler";
export { InngestCommHandler } from "./components/InngestCommHandler.js";
export type { InngestFunction } from "./components/InngestFunction";
export type { InngestFunctionReference } from "./components/InngestFunctionReference";
export { referenceFunction } from "./components/InngestFunctionReference.js";
export type { MiddlewareOptions, MiddlewareRegisterFn, MiddlewareRegisterReturn, } from "./components/InngestMiddleware";
export { InngestMiddleware } from "./components/InngestMiddleware.js";
export { NonRetriableError } from "./components/NonRetriableError.js";
export { RetryAfterError } from "./components/RetryAfterError.js";
export { StepError } from "./components/StepError.js";
export { headerKeys, internalEvents, queryKeys } from "./helpers/consts.js";
export { slugify } from "./helpers/strings.js";
export type { IsStringLiteral, StrictUnion, StrictUnionHelper, UnionKeys, WithoutInternal, } from "./helpers/types";
export { dependencyInjectionMiddleware } from "./middleware/dependencyInjection.js";
export type { LogArg } from "./middleware/logger";
export { ProxyLogger } from "./middleware/logger.js";
export type { BaseContext, ClientOptions, Context, EventNameFromTrigger, EventPayload, FailureEventArgs, FailureEventPayload, FinishedEventPayload, Handler, JsonError, LogLevel, OutgoingOp, RegisterOptions, ScheduledTimerEventPayload, SendEventBaseOutput, StepOptions, StepOptionsOrId, TimeStr, } from "./types";
export { version } from "./version.js";
//# sourceMappingURL=index.d.ts.map