Type Alias ZodObjectV3

Type declaration

• and: (<T>(incoming: T) => ZodIntersection<ZodObjectV3, T>)

  • • <T>(incoming): ZodIntersection<ZodObjectV3, T>

    • Type Parameters

      • T extends ZodTypeAny

      Parameters

      • incoming: T

      Returns ZodIntersection<ZodObjectV3, T>

• array: (() => ZodArray<ZodObjectV3, "many">)

  • • (): ZodArray<ZodObjectV3, "many">

    • Returns ZodArray<ZodObjectV3, "many">

• augment: (<Augmentation>(augmentation: Augmentation) => ZodObject<extendShape<any, Augmentation>, any, any, {
      [k in string | number | symbol]: addQuestionMarks<baseObjectOutputType<extendShape<any, Augmentation>>, any>[k]
  }, {
      [k in string | number | symbol]: baseObjectInputType<extendShape<any, Augmentation>>[k]
  }>)

  • • <Augmentation>(augmentation): ZodObject<extendShape<any, Augmentation>, any, any, {
          [k in string | number | symbol]: addQuestionMarks<baseObjectOutputType<extendShape<any, Augmentation>>, any>[k]
      }, {
          [k in string | number | symbol]: baseObjectInputType<extendShape<any, Augmentation>>[k]
      }>

    • Type Parameters

      • Augmentation extends ZodRawShape

      Parameters

      • augmentation: Augmentation

      Returns ZodObject<extendShape<any, Augmentation>, any, any, {
          [k in string | number | symbol]: addQuestionMarks<baseObjectOutputType<extendShape<any, Augmentation>>, any>[k]
      }, {
          [k in string | number | symbol]: baseObjectInputType<extendShape<any, Augmentation>>[k]
      }>

      Deprecated

      Use .extend instead

• brand: (<B>(brand?: B) => ZodBranded<ZodObjectV3, B>)

  • • <B>(brand?): ZodBranded<ZodObjectV3, B>

    • Type Parameters

      • B extends string | number | symbol

      Parameters

      • Optionalbrand: B

      Returns ZodBranded<ZodObjectV3, B>

• catch: {
      (def: any): ZodCatch<ZodObjectV3>;
      (def: ((ctx: {
          error: ZodError<any>;
          input: {};
      }) => any)): ZodCatch<ZodObjectV3>;
  }

  • • (def): ZodCatch<ZodObjectV3>

    • Parameters

      • def: any

      Returns ZodCatch<ZodObjectV3>

    • (def): ZodCatch<ZodObjectV3>

    • Parameters

      • def: ((ctx: {
            error: ZodError<any>;
            input: {};
        }) => any)
        • • (ctx): any

          • Parameters

            • ctx: {
                  error: ZodError<any>;
                  input: {};
              }

              • error: ZodError<any>

              • input: {}

            Returns any

      Returns ZodCatch<ZodObjectV3>

• catchall: (<Index>(index: Index) => ZodObject<any, any, Index, objectOutputType<any, Index, any>, objectInputType<any, Index, any>>)

  • • <Index>(index): ZodObject<any, any, Index, objectOutputType<any, Index, any>, objectInputType<any, Index, any>>

    • Type Parameters

      • Index extends ZodTypeAny

      Parameters

      • index: Index

      Returns ZodObject<any, any, Index, objectOutputType<any, Index, any>, objectInputType<any, Index, any>>

• deepPartial: (() => ZodObject<{}, any, any, {}, {}>)

  • • (): ZodObject<{}, any, any, {}, {}>

    • Returns ZodObject<{}, any, any, {}, {}>

      Deprecated

• default: {
      (def: {}): ZodDefault<ZodObjectV3>;
      (def: (() => {})): ZodDefault<ZodObjectV3>;
  }

  • • (def): ZodDefault<ZodObjectV3>

    • Parameters

      • def: {}

      Returns ZodDefault<ZodObjectV3>

    • (def): ZodDefault<ZodObjectV3>

    • Parameters

      • def: (() => {})
        • • (): {}

          • Returns {}

      Returns ZodDefault<ZodObjectV3>

• describe: ((description: string) => this)

  • • (description): this

    • Parameters

      • description: string

      Returns this

• description: undefined | string

• extend: (<Augmentation>(augmentation: Augmentation) => ZodObject<extendShape<any, Augmentation>, any, any, {
      [k in string | number | symbol]: addQuestionMarks<baseObjectOutputType<extendShape<any, Augmentation>>, any>[k]
  }, {
      [k in string | number | symbol]: baseObjectInputType<extendShape<any, Augmentation>>[k]
  }>)

  • • <Augmentation>(augmentation): ZodObject<extendShape<any, Augmentation>, any, any, {
          [k in string | number | symbol]: addQuestionMarks<baseObjectOutputType<extendShape<any, Augmentation>>, any>[k]
      }, {
          [k in string | number | symbol]: baseObjectInputType<extendShape<any, Augmentation>>[k]
      }>

    • Type Parameters

      • Augmentation extends ZodRawShape

      Parameters

      • augmentation: Augmentation

      Returns ZodObject<extendShape<any, Augmentation>, any, any, {
          [k in string | number | symbol]: addQuestionMarks<baseObjectOutputType<extendShape<any, Augmentation>>, any>[k]
      }, {
          [k in string | number | symbol]: baseObjectInputType<extendShape<any, Augmentation>>[k]
      }>

• isNullable: (() => boolean)

  • • (): boolean

    • Returns boolean

• isOptional: (() => boolean)

  • • (): boolean

    • Returns boolean

• keyof: (() => ZodEnum<never>)

  • • (): ZodEnum<never>

    • Returns ZodEnum<never>

• merge: (<Incoming, Augmentation>(merging: Incoming) => ZodObject<extendShape<any, Augmentation>, Incoming["_def"]["unknownKeys"], Incoming["_def"]["catchall"], objectOutputType<extendShape<any, Augmentation>, Incoming["_def"]["catchall"], Incoming["_def"]["unknownKeys"]>, objectInputType<extendShape<any, Augmentation>, Incoming["_def"]["catchall"], Incoming["_def"]["unknownKeys"]>>)

  • • <Incoming, Augmentation>(merging): ZodObject<extendShape<any, Augmentation>, Incoming["_def"]["unknownKeys"], Incoming["_def"]["catchall"], objectOutputType<extendShape<any, Augmentation>, Incoming["_def"]["catchall"], Incoming["_def"]["unknownKeys"]>, objectInputType<extendShape<any, Augmentation>, Incoming["_def"]["catchall"], Incoming["_def"]["unknownKeys"]>>

    • Prior to zod@1.0.12 there was a bug in the inferred type of merged objects. Please upgrade if you are experiencing issues.

      Type Parameters

      • Incoming extends AnyZodObject
      • Augmentation extends any

      Parameters

      • merging: Incoming

      Returns ZodObject<extendShape<any, Augmentation>, Incoming["_def"]["unknownKeys"], Incoming["_def"]["catchall"], objectOutputType<extendShape<any, Augmentation>, Incoming["_def"]["catchall"], Incoming["_def"]["unknownKeys"]>, objectInputType<extendShape<any, Augmentation>, Incoming["_def"]["catchall"], Incoming["_def"]["unknownKeys"]>>

• nonstrict: (() => ZodObject<any, "passthrough", any, objectOutputType<any, any, "passthrough">, objectInputType<any, any, "passthrough">>)

  • • (): ZodObject<any, "passthrough", any, objectOutputType<any, any, "passthrough">, objectInputType<any, any, "passthrough">>

    • Returns ZodObject<any, "passthrough", any, objectOutputType<any, any, "passthrough">, objectInputType<any, any, "passthrough">>

      Deprecated

      In most cases, this is no longer needed - unknown properties are now silently stripped. If you want to pass through unknown properties, use .passthrough() instead.

• nullable: (() => ZodNullable<ZodObjectV3>)

  • • (): ZodNullable<ZodObjectV3>

    • Returns ZodNullable<ZodObjectV3>

• nullish: (() => ZodOptional<ZodNullable<ZodObjectV3>>)

  • • (): ZodOptional<ZodNullable<ZodObjectV3>>

    • Returns ZodOptional<ZodNullable<ZodObjectV3>>

• omit: (<Mask>(mask: Mask) => ZodObject<Omit<any, keyof Mask>, any, any, {
      [k in string | number | symbol]: addQuestionMarks<baseObjectOutputType<Omit<any, keyof Mask>>, any>[k]
  }, {
      [k in string | number | symbol]: baseObjectInputType<Omit<any, keyof Mask>>[k]
  }>)

  • • <Mask>(mask): ZodObject<Omit<any, keyof Mask>, any, any, {
          [k in string | number | symbol]: addQuestionMarks<baseObjectOutputType<Omit<any, keyof Mask>>, any>[k]
      }, {
          [k in string | number | symbol]: baseObjectInputType<Omit<any, keyof Mask>>[k]
      }>

    • Type Parameters

      • Mask extends Exactly<{}, Mask>

      Parameters

      • mask: Mask

      Returns ZodObject<Omit<any, keyof Mask>, any, any, {
          [k in string | number | symbol]: addQuestionMarks<baseObjectOutputType<Omit<any, keyof Mask>>, any>[k]
      }, {
          [k in string | number | symbol]: baseObjectInputType<Omit<any, keyof Mask>>[k]
      }>

• optional: (() => ZodOptional<ZodObjectV3>)

  • • (): ZodOptional<ZodObjectV3>

    • Returns ZodOptional<ZodObjectV3>

• or: (<T>(option: T) => ZodUnion<[ZodObjectV3, T]>)

  • • <T>(option): ZodUnion<[ZodObjectV3, T]>

    • Type Parameters

      • T extends ZodTypeAny

      Parameters

      • option: T

      Returns ZodUnion<[ZodObjectV3, T]>

• parse: ((data: unknown, params?: InexactPartial<ParseParams>) => any)

  • • (data, params?): any

    • Parameters

      • data: unknown
      • Optionalparams: InexactPartial<ParseParams>

      Returns any

• parseAsync: ((data: unknown, params?: InexactPartial<ParseParams>) => Promise<any>)

  • • (data, params?): Promise<any>

    • Parameters

      • data: unknown
      • Optionalparams: InexactPartial<ParseParams>

      Returns Promise<any>

• partial: {
      (): ZodObject<{}, any, any, {}, {}>;
      <Mask>(mask: Mask): ZodObject<{
          [k in string]: k extends string | number | symbol
              ? string extends keyof Mask
                  ? ZodOptional<any>
                  : any
              : never
      }, any, any, {
          [k in string]: addQuestionMarks<baseObjectOutputType<{
              [k in string]: k extends string | number | symbol
                  ? string extends keyof Mask
                      ? ZodOptional<any>
                      : any
                  : never
          }>, any>[k]
      }, {
          [k in string]: baseObjectInputType<{
              [k in string]: k extends string | number | symbol
                  ? string extends keyof Mask
                      ? ZodOptional<any>
                      : any
                  : never
          }>[k]
      }>;
  }

  • • (): ZodObject<{}, any, any, {}, {}>

    • Returns ZodObject<{}, any, any, {}, {}>

    • <Mask>(mask): ZodObject<{
          [k in string]: k extends string | number | symbol
              ? string extends keyof Mask
                  ? ZodOptional<any>
                  : any
              : never
      }, any, any, {
          [k in string]: addQuestionMarks<baseObjectOutputType<{
              [k in string]: k extends string | number | symbol
                  ? string extends keyof Mask
                      ? ZodOptional<any>
                      : any
                  : never
          }>, any>[k]
      }, {
          [k in string]: baseObjectInputType<{
              [k in string]: k extends string | number | symbol
                  ? string extends keyof Mask
                      ? ZodOptional<any>
                      : any
                  : never
          }>[k]
      }>

    • Type Parameters

      • Mask extends Exactly<{}, Mask>

      Parameters

      • mask: Mask

      Returns ZodObject<{
          [k in string]: k extends string | number | symbol
              ? string extends keyof Mask
                  ? ZodOptional<any>
                  : any
              : never
      }, any, any, {
          [k in string]: addQuestionMarks<baseObjectOutputType<{
              [k in string]: k extends string | number | symbol
                  ? string extends keyof Mask
                      ? ZodOptional<any>
                      : any
                  : never
          }>, any>[k]
      }, {
          [k in string]: baseObjectInputType<{
              [k in string]: k extends string | number | symbol
                  ? string extends keyof Mask
                      ? ZodOptional<any>
                      : any
                  : never
          }>[k]
      }>

• passthrough: (() => ZodObject<any, "passthrough", any, objectOutputType<any, any, "passthrough">, objectInputType<any, any, "passthrough">>)

  • • (): ZodObject<any, "passthrough", any, objectOutputType<any, any, "passthrough">, objectInputType<any, any, "passthrough">>

    • Returns ZodObject<any, "passthrough", any, objectOutputType<any, any, "passthrough">, objectInputType<any, any, "passthrough">>

• pick: (<Mask>(mask: Mask) => ZodObject<Pick<any, Extract<string, keyof Mask> | Extract<number, keyof Mask> | Extract<symbol, keyof Mask>>, any, any, {
      [k in string | number | symbol]: addQuestionMarks<baseObjectOutputType<Pick<any, Extract<string, keyof Mask> | Extract<number, keyof Mask> | Extract<symbol, keyof Mask>>>, any>[k]
  }, {
      [k in string | number | symbol]: baseObjectInputType<Pick<any, Extract<string, keyof Mask> | Extract<number, keyof Mask> | Extract<symbol, keyof Mask>>>[k]
  }>)

  • • <Mask>(mask): ZodObject<Pick<any, Extract<string, keyof Mask> | Extract<number, keyof Mask> | Extract<symbol, keyof Mask>>, any, any, {
          [k in string | number | symbol]: addQuestionMarks<baseObjectOutputType<Pick<any, Extract<string, keyof Mask> | Extract<number, keyof Mask> | Extract<symbol, keyof Mask>>>, any>[k]
      }, {
          [k in string | number | symbol]: baseObjectInputType<Pick<any, Extract<string, keyof Mask> | Extract<number, keyof Mask> | Extract<symbol, keyof Mask>>>[k]
      }>

    • Type Parameters

      • Mask extends Exactly<{}, Mask>

      Parameters

      • mask: Mask

      Returns ZodObject<Pick<any, Extract<string, keyof Mask> | Extract<number, keyof Mask> | Extract<symbol, keyof Mask>>, any, any, {
          [k in string | number | symbol]: addQuestionMarks<baseObjectOutputType<Pick<any, Extract<string, keyof Mask> | Extract<number, keyof Mask> | Extract<symbol, keyof Mask>>>, any>[k]
      }, {
          [k in string | number | symbol]: baseObjectInputType<Pick<any, Extract<string, keyof Mask> | Extract<number, keyof Mask> | Extract<symbol, keyof Mask>>>[k]
      }>

• pipe: (<T>(target: T) => ZodPipeline<ZodObjectV3, T>)

  • • <T>(target): ZodPipeline<ZodObjectV3, T>

    • Type Parameters

      • T extends ZodTypeAny

      Parameters

      • target: T

      Returns ZodPipeline<ZodObjectV3, T>

• promise: (() => ZodPromise<ZodObjectV3>)

  • • (): ZodPromise<ZodObjectV3>

    • Returns ZodPromise<ZodObjectV3>

• readonly: (() => ZodReadonly<ZodObjectV3>)

  • • (): ZodReadonly<ZodObjectV3>

    • Returns ZodReadonly<ZodObjectV3>

• refine: {
      <RefinedOutput>(check: ((arg: any) => arg is RefinedOutput), message?: string | Partial<Omit<ZodCustomIssue, "code">> | ((arg: any) => Partial<Omit<ZodCustomIssue, "code">>)): ZodEffects<ZodObjectV3, RefinedOutput, {}>;
      (check: ((arg: any) => unknown), message?: string | Partial<Omit<ZodCustomIssue, "code">> | ((arg: any) => Partial<Omit<ZodCustomIssue, "code">>)): ZodEffects<ZodObjectV3, any, {}>;
  }

  • • <RefinedOutput>(check, message?): ZodEffects<ZodObjectV3, RefinedOutput, {}>

    • Type Parameters

      • RefinedOutput extends any

      Parameters

      • check: ((arg: any) => arg is RefinedOutput)
        • • (arg): arg is RefinedOutput

          • Parameters

            • arg: any

            Returns arg is RefinedOutput

      • Optionalmessage: string | Partial<Omit<ZodCustomIssue, "code">> | ((arg: any) => Partial<Omit<ZodCustomIssue, "code">>)

      Returns ZodEffects<ZodObjectV3, RefinedOutput, {}>

    • (check, message?): ZodEffects<ZodObjectV3, any, {}>

    • Parameters

      • check: ((arg: any) => unknown)
        • • (arg): unknown

          • Parameters

            • arg: any

            Returns unknown

      • Optionalmessage: string | Partial<Omit<ZodCustomIssue, "code">> | ((arg: any) => Partial<Omit<ZodCustomIssue, "code">>)

      Returns ZodEffects<ZodObjectV3, any, {}>

• refinement: {
      <RefinedOutput>(check: ((arg: any) => arg is RefinedOutput), refinementData: IssueData | ((arg: any, ctx: RefinementCtx) => IssueData)): ZodEffects<ZodObjectV3, RefinedOutput, {}>;
      (check: ((arg: any) => boolean), refinementData: IssueData | ((arg: any, ctx: RefinementCtx) => IssueData)): ZodEffects<ZodObjectV3, any, {}>;
  }

  • • <RefinedOutput>(check, refinementData): ZodEffects<ZodObjectV3, RefinedOutput, {}>

    • Type Parameters

      • RefinedOutput extends any

      Parameters

      • check: ((arg: any) => arg is RefinedOutput)
        • • (arg): arg is RefinedOutput

          • Parameters

            • arg: any

            Returns arg is RefinedOutput

      • refinementData: IssueData | ((arg: any, ctx: RefinementCtx) => IssueData)

      Returns ZodEffects<ZodObjectV3, RefinedOutput, {}>

    • (check, refinementData): ZodEffects<ZodObjectV3, any, {}>

    • Parameters

      • check: ((arg: any) => boolean)
        • • (arg): boolean

          • Parameters

            • arg: any

            Returns boolean

      • refinementData: IssueData | ((arg: any, ctx: RefinementCtx) => IssueData)

      Returns ZodEffects<ZodObjectV3, any, {}>

• required: {
      (): ZodObject<{}, any, any, {}, {}>;
      <Mask>(mask: Mask): ZodObject<{
          [k in string]: k extends string | number | symbol
              ? string extends keyof Mask
                  ? any
                  : any
              : never
      }, any, any, {
          [k in string]: addQuestionMarks<baseObjectOutputType<{
              [k in string]: k extends string | number | symbol
                  ? string extends keyof Mask
                      ? any
                      : any
                  : never
          }>, any>[k]
      }, {
          [k in string]: baseObjectInputType<{
              [k in string]: k extends string | number | symbol
                  ? string extends keyof Mask
                      ? any
                      : any
                  : never
          }>[k]
      }>;
  }

  • • (): ZodObject<{}, any, any, {}, {}>

    • Returns ZodObject<{}, any, any, {}, {}>

    • <Mask>(mask): ZodObject<{
          [k in string]: k extends string | number | symbol
              ? string extends keyof Mask
                  ? any
                  : any
              : never
      }, any, any, {
          [k in string]: addQuestionMarks<baseObjectOutputType<{
              [k in string]: k extends string | number | symbol
                  ? string extends keyof Mask
                      ? any
                      : any
                  : never
          }>, any>[k]
      }, {
          [k in string]: baseObjectInputType<{
              [k in string]: k extends string | number | symbol
                  ? string extends keyof Mask
                      ? any
                      : any
                  : never
          }>[k]
      }>

    • Type Parameters

      • Mask extends Exactly<{}, Mask>

      Parameters

      • mask: Mask

      Returns ZodObject<{
          [k in string]: k extends string | number | symbol
              ? string extends keyof Mask
                  ? any
                  : any
              : never
      }, any, any, {
          [k in string]: addQuestionMarks<baseObjectOutputType<{
              [k in string]: k extends string | number | symbol
                  ? string extends keyof Mask
                      ? any
                      : any
                  : never
          }>, any>[k]
      }, {
          [k in string]: baseObjectInputType<{
              [k in string]: k extends string | number | symbol
                  ? string extends keyof Mask
                      ? any
                      : any
                  : never
          }>[k]
      }>

• safeParse: ((data: unknown, params?: InexactPartial<ParseParams>) => SafeParseReturnType<{}, any>)

  • • (data, params?): SafeParseReturnType<{}, any>

    • Parameters

      • data: unknown
      • Optionalparams: InexactPartial<ParseParams>

      Returns SafeParseReturnType<{}, any>

• safeParseAsync: ((data: unknown, params?: InexactPartial<ParseParams>) => Promise<SafeParseReturnType<{}, any>>)

  • • (data, params?): Promise<SafeParseReturnType<{}, any>>

    • Parameters

      • data: unknown
      • Optionalparams: InexactPartial<ParseParams>

      Returns Promise<SafeParseReturnType<{}, any>>

• setKey: (<Key, Schema>(key: Key, schema: Schema) => ZodObject<any, any, any, {}, {}>)

  • • <Key, Schema>(key, schema): ZodObject<any, any, any, {}, {}>

    • Type Parameters

      • Key extends string
      • Schema extends ZodTypeAny

      Parameters

      • key: Key
      • schema: Schema

      Returns ZodObject<any, any, any, {}, {}>

• shape: any

• spa: ((data: unknown, params?: InexactPartial<ParseParams>) => Promise<SafeParseReturnType<{}, any>>)

  • • (data, params?): Promise<SafeParseReturnType<{}, any>>

    • Alias of safeParseAsync

      Parameters

      • data: unknown
      • Optionalparams: InexactPartial<ParseParams>

      Returns Promise<SafeParseReturnType<{}, any>>

• strict: ((message?: ErrMessage) => ZodObject<any, "strict", any, {}, {}>)

  • • (message?): ZodObject<any, "strict", any, {}, {}>

    • Parameters

      • Optionalmessage: ErrMessage

      Returns ZodObject<any, "strict", any, {}, {}>

• strip: (() => ZodObject<any, "strip", any, {}, {}>)

  • • (): ZodObject<any, "strip", any, {}, {}>

    • Returns ZodObject<any, "strip", any, {}, {}>

• superRefine: {
      <RefinedOutput>(refinement: ((arg: any, ctx: RefinementCtx) => arg is RefinedOutput)): ZodEffects<ZodObjectV3, RefinedOutput, {}>;
      (refinement: ((arg: any, ctx: RefinementCtx) => void)): ZodEffects<ZodObjectV3, any, {}>;
      (refinement: ((arg: any, ctx: RefinementCtx) => Promise<void>)): ZodEffects<ZodObjectV3, any, {}>;
  }

  • • <RefinedOutput>(refinement): ZodEffects<ZodObjectV3, RefinedOutput, {}>

    • Type Parameters

      • RefinedOutput extends any

      Parameters

      • refinement: ((arg: any, ctx: RefinementCtx) => arg is RefinedOutput)
        • • (arg, ctx): arg is RefinedOutput

          • Parameters

            • arg: any
            • ctx: RefinementCtx

            Returns arg is RefinedOutput

      Returns ZodEffects<ZodObjectV3, RefinedOutput, {}>

    • (refinement): ZodEffects<ZodObjectV3, any, {}>

    • Parameters

      • refinement: ((arg: any, ctx: RefinementCtx) => void)
        • • (arg, ctx): void

          • Parameters

            • arg: any
            • ctx: RefinementCtx

            Returns void

      Returns ZodEffects<ZodObjectV3, any, {}>

    • (refinement): ZodEffects<ZodObjectV3, any, {}>

    • Parameters

      • refinement: ((arg: any, ctx: RefinementCtx) => Promise<void>)
        • • (arg, ctx): Promise<void>

          • Parameters

            • arg: any
            • ctx: RefinementCtx

            Returns Promise<void>

      Returns ZodEffects<ZodObjectV3, any, {}>

• transform: (<NewOut>(transform: ((arg: any, ctx: RefinementCtx) => NewOut | Promise<NewOut>)) => ZodEffects<ZodObjectV3, NewOut, {}>)

  • • <NewOut>(transform): ZodEffects<ZodObjectV3, NewOut, {}>

    • Type Parameters

      • NewOut

      Parameters

      • transform: ((arg: any, ctx: RefinementCtx) => NewOut | Promise<NewOut>)
        • • (arg, ctx): NewOut | Promise<NewOut>

          • Parameters

            • arg: any
            • ctx: RefinementCtx

            Returns NewOut | Promise<NewOut>

      Returns ZodEffects<ZodObjectV3, NewOut, {}>

• ~standard: Props<{}, any>

• ~validate: ((data: unknown) => Result<any> | Promise<Result<any>>)

  • • (data): Result<any> | Promise<Result<any>>

    • Parameters

      • data: unknown

      Returns Result<any> | Promise<Result<any>>