@trpc/server
Version:
98 lines • 3.19 kB
TypeScript
import type { CombinedDataTransformer } from '../unstable-core-do-not-import';
import type { DefaultErrorShape, ErrorFormatter } from './error/formatter';
import type { JSONLProducerOptions } from './stream/jsonl';
import type { SSEStreamProducerOptions } from './stream/sse';
/**
* The initial generics that are used in the init function
* @internal
*/
export interface RootTypes {
ctx: object;
meta: object;
errorShape: DefaultErrorShape;
transformer: boolean;
}
/**
* The default check to see if we're in a server
*/
export declare const isServerDefault: boolean;
/**
* The tRPC root config
* @internal
*/
export interface RootConfig<TTypes extends RootTypes> {
/**
* The types that are used in the config
* @internal
*/
$types: TTypes;
/**
* Use a data transformer
* @see https://trpc.io/docs/v11/data-transformers
*/
transformer: CombinedDataTransformer;
/**
* Use custom error formatting
* @see https://trpc.io/docs/v11/error-formatting
*/
errorFormatter: ErrorFormatter<TTypes['ctx'], TTypes['errorShape']>;
/**
* Allow `@trpc/server` to run in non-server environments
* @warning **Use with caution**, this should likely mainly be used within testing.
* @default false
*/
allowOutsideOfServer: boolean;
/**
* Is this a server environment?
* @warning **Use with caution**, this should likely mainly be used within testing.
* @default typeof window === 'undefined' || 'Deno' in window || process.env.NODE_ENV === 'test'
*/
isServer: boolean;
/**
* Is this development?
* Will be used to decide if the API should return stack traces
* @default process.env.NODE_ENV !== 'production'
*/
isDev: boolean;
defaultMeta?: TTypes['meta'] extends object ? TTypes['meta'] : never;
/**
* Options for server-sent events (SSE) subscriptions
* @see https://trpc.io/docs/client/links/httpSubscriptionLink
*/
sse?: {
/**
* Enable server-sent events (SSE) subscriptions
* @default true
*/
enabled?: boolean;
} & Pick<SSEStreamProducerOptions, 'ping' | 'emitAndEndImmediately' | 'maxDurationMs' | 'client'>;
/**
* Options for batch stream
* @see https://trpc.io/docs/client/links/httpBatchStreamLink
*/
jsonl?: Pick<JSONLProducerOptions, 'pingMs'>;
experimental?: {};
}
/**
* @internal
*/
export type CreateRootTypes<TGenerics extends RootTypes> = TGenerics;
export type AnyRootTypes = CreateRootTypes<{
ctx: any;
meta: any;
errorShape: any;
transformer: any;
}>;
type PartialIf<TCondition extends boolean, TType> = TCondition extends true ? Partial<TType> : TType;
/**
* Adds a `createContext` option with a given callback function
* If context is the default value, then the `createContext` option is optional
*/
export type CreateContextCallback<TContext, TFunction extends (...args: any[]) => any> = PartialIf<object extends TContext ? true : false, {
/**
* @see https://trpc.io/docs/v11/context
**/
createContext: TFunction;
}>;
export {};
//# sourceMappingURL=rootConfig.d.ts.map