Interface ErrorFluentBuilder<TData>

id

build

• build(): IErrorHelper<TData>

  Materializes the final error helper for registration or reuse.

  Returns IErrorHelper<TData>

dataSchema

• dataSchema<
      TNewData extends DefaultErrorType = never,
      TSchema extends
          ValidationSchemaInput<[TNewData] extends [never] ? any : TNewData> = ValidationSchemaInput<
          [TNewData] extends [never] ? any : TNewData,
      >,
  >(
      schema: TSchema,
  ): ErrorFluentBuilder<
      ResolveValidationSchemaInput<TNewData, TSchema> & DefaultErrorType,
  >

  Declares the error data schema.

  Type Parameters

  • TNewData extends DefaultErrorType = never
  • TSchema extends ValidationSchemaInput<[TNewData] extends [never] ? any : TNewData> = ValidationSchemaInput<[TNewData] extends [never] ? any : TNewData>

  Parameters

  • schema: TSchema

  Returns ErrorFluentBuilder<
      ResolveValidationSchemaInput<TNewData, TSchema> & DefaultErrorType,
  >

format

• format(fn: (data: TData) => string): ErrorFluentBuilder<TData>

  Sets the user-facing message formatter.

  Parameters

  • fn: (data: TData) => string

  Returns ErrorFluentBuilder<TData>

httpCode

• httpCode(code: number): ErrorFluentBuilder<TData>

  Associates an HTTP status code with the error helper.

  Parameters

  • code: number

  Returns ErrorFluentBuilder<TData>

meta

• meta<TNewMeta extends IErrorMeta>(m: TNewMeta): ErrorFluentBuilder<TData>

  Attaches metadata used by docs and tooling.

  Type Parameters

  • TNewMeta extends IErrorMeta

  Parameters

  • m: TNewMeta

  Returns ErrorFluentBuilder<TData>

parse

• parse(fn: (raw: string) => TData): ErrorFluentBuilder<TData>

  Provides a custom parser paired with serialize.

  Parameters

  • fn: (raw: string) => TData

  Returns ErrorFluentBuilder<TData>

remediation

• remediation(
      advice: string | ((data: TData) => string),
  ): ErrorFluentBuilder<TData>

  Attach remediation advice that explains how to fix this error. Appears in the stringified error after the main message.

  Parameters

  • advice: string | ((data: TData) => string)

  Returns ErrorFluentBuilder<TData>

schema

• schema<
      TNewData extends DefaultErrorType = never,
      TSchema extends
          ValidationSchemaInput<[TNewData] extends [never] ? any : TNewData> = ValidationSchemaInput<
          [TNewData] extends [never] ? any : TNewData,
      >,
  >(
      schema: TSchema,
  ): ErrorFluentBuilder<
      ResolveValidationSchemaInput<TNewData, TSchema> & DefaultErrorType,
  >

  Alias for dataSchema. Use this to define the error data validation contract.

  Type Parameters

  • TNewData extends DefaultErrorType = never
  • TSchema extends ValidationSchemaInput<[TNewData] extends [never] ? any : TNewData> = ValidationSchemaInput<[TNewData] extends [never] ? any : TNewData>

  Parameters

  • schema: TSchema

  Returns ErrorFluentBuilder<
      ResolveValidationSchemaInput<TNewData, TSchema> & DefaultErrorType,
  >

serialize

• serialize(fn: (data: TData) => string): ErrorFluentBuilder<TData>

  Provides a custom serializer for transport or persistence scenarios.

  Parameters

  • fn: (data: TData) => string

  Returns ErrorFluentBuilder<TData>

tags

• tags<TNewTags extends ErrorTagType[]>(
      t: EnsureTagsForTarget<"errors", TNewTags>,
      options?: { override?: boolean },
  ): ErrorFluentBuilder<TData>

  Adds or replaces error tags.

  Type Parameters

  • TNewTags extends ErrorTagType[]

  Parameters

  • t: EnsureTagsForTarget<"errors", TNewTags>
  • Optionaloptions: { override?: boolean }

  Returns ErrorFluentBuilder<TData>