Generated API snapshot
@askrjs/askr/ssr
Exports from the declarations published in @askrjs/askr 0.0.59. Signatures are generated from the installed artifact.
@askrjs/askr/ssr0.0.59
Exports
This entrypoint publishes 20 exports. Use the anchored symbol rows for direct links. Type-only exports are labeled separately from runtime values.
createRenderContexttype
createRenderContext: (seed?: number, opts?: { url?: string; data?: SSRData; params?: Record<string, string>; routes?: readonly Route[]; routeAuth?: RouteAuthOptions; signal?: AbortSignal; dataRuntime?: unknown; mode?: "ssr" | "spa"; queryPrefetch?: QueryPrefetchContext; framework?: Readonly<Record<string, unknown>>; envelope?: PageRenderEnvelope; }) => RenderContextDocumentRenderArgstype
DocumentRenderArgs: anyDocumentRenderContexttype
DocumentRenderContext: anyDocumentRenderertype
DocumentRenderer: anygetRenderContexttype
getRenderContext: () => RenderContext | nullrenderResolvedToStringSynctype
renderResolvedToStringSync: (opts: { url: string; routes: ReadonlyArray<{ path: string; handler: RouteHandler; namespace?: string; }>; handler: RouteHandler; params?: Record<string, string>; options?: { seed?: number; data?: SSRData; dataRuntime?: DataRuntime; envelope?: PageRenderEnvelope; }; }) => stringrenderRouteRequesttype
renderRouteRequest: (options: RenderRouteRequestOptions) => Promise<RenderRouteRequestResult>RenderRouteRequestOptionstype
RenderRouteRequestOptions: anyRenderRouteRequestResulttype
RenderRouteRequestResult: anyrenderRouteRequestToStringtype
renderRouteRequestToString: (options: RenderRouteRequestOptions) => Promise<RenderRouteRequestResult>renderToStreamtype
renderToStream: (opts: RouteStreamOptions) => voidrenderToStringtype
renderToString: { (component: (props?: Record<string, unknown>) => VNode | JSXElement | string | number | null): string; (opts: RouteRenderOptions): string; }renderToStringSynctype
renderToStringSync: (component: (props?: Record<string, unknown>) => VNode | JSXElement | string | number | boolean | null | undefined, props?: Record<string, unknown>, options?: { seed?: number; data?: SSRData; envelope?: PageRenderEnvelope; }) => stringresolveRequesttype
resolveRequest: (opts: { url: string; registry: RouteRegistry; manifest?: RouteManifest; routes?: Array<{ path: string; handler: RouteHandler; namespace?: string; }>; auth?: RouteAuthOptions; authContext?: AuthContext; request?: Request; signal?: AbortSignal; } | { url: string; manifest: RouteManifest; registry?: RouteRegistry; routes?: Array<{ path: string; handler: RouteHandler; namespace?: string; }>; auth?: RouteAuthOptions; authContext?: AuthContext; request?: Request; signal?: AbortSignal; } | { url: string; manifest?: RouteManifest; registry?: RouteRegistry; routes: Array<{ path: string; handler: RouteHandler; namespace?: string; }>; auth?: RouteAuthOptions; authContext?: AuthContext; request?: Request; signal?: AbortSignal; }) => Promise<RouteRequestResult>SSRComponenttype
SSRComponent: anySSRDataMissingErrortype
SSRDataMissingError: typeof SSRDataMissingErrorSSRRoutetype
SSRRoute: anyVNodetype
VNode: anywithRenderContexttype
withRenderContext: <T>(ctx: RenderContext, fn: () => T) => TwithRenderContextAsynctype
withRenderContextAsync: <T>(ctx: RenderContext, fn: () => T | PromiseLike<T>) => Promise<T>