Hello, I'm trying to validate data that must contain a TypeBox schem

<a class="user-mention notranslate" data-hovercard-type="user" data-hovercard-url="/us

Type.Schema about typebox HOT 2 CLOSED

pterrien commented on July 18, 2024

Type.Schema

from typebox.

Comments (2)

pterrien commented on July 18, 2024 1

Once again, thank you for your super quick answer, the level of support on this repo is truly amazing. :)
That's a very straightforward and elegant solution indeed.

Many thanks, that really helps!

from typebox.

sinclairzx81 commented on July 18, 2024

@pterrien Hi,

There's a few of ways to approach this, most of which comes down to how you want your plugin API to look, and how types contribute to inference elsewhere. Perhaps the following helps?

TypeScript Link Here

import { Type, Static, TSchema, TObject } from '@sinclair/typebox'

// if you want a specialized object type
export interface TPlugin<Config extends TSchema> extends TObject<{ config: Config }> { }

// this is a factory function for the type above
export function Plugin<Config extends TSchema>(config: Config): TPlugin<Config> {
  return Type.Object({ config })
}

// A and B are types of TPlugin
const A = Plugin(Type.Object({ x: Type.Number(), y: Type.Number() }))

const B = Plugin(Type.Object({ a: Type.String(), b: Type.String() }))

type A = Static<typeof A>

type B = Static<typeof B>

Additionally, would it be possible to restrict the type of schema? In my case the corresponding TS type would be TObject obviously.

You can constrain the generic Config parameter to be of TObject only in the following way.

TypeScript Link Here

import { Type, TObject } from '@sinclair/typebox'

export interface TPlugin<Config extends TObject> extends TObject<{ config: Config }> { }

export function Plugin<Config extends TObject>(config: Config): TPlugin<Config> {
  return Type.Object({ config })
}

const X = Plugin(Type.String()) // error: Argument of type 'TString' is not assignable to parameter of type 'TObject<TProperties>'.