Customizable name for Options?

[sleewoo]

Congrats on v1 release!

The new refinement through Options is awesome, but... as usual there is a but :)

I'm using Options name pretty frequently in my projects and now i have to either move schemas with refinements to separate files or to import { Options as CoreOptions } from "@/core"
Both prertty incovenient, involves lot of moving.

Perhaps makes sense to add (unless already) a way to customize Options name?
Perhaps a global option in typebox/system or per schema option somehow?

Thanks

[sinclairzx81]

@sleewoo Hi,

Congrats on v1 release!

Hey, Thanks! :) It took many years!!

Perhaps makes sense to add (unless already) a way to customize Options name? Perhaps a global option in typebox/system or per schema option somehow?

Unfortunately, I can't really change the name for Options at this point as it is heavily integrated into the Script parser and used internally as a intrinsic generic type, mostly in support of the following.

Reference

const User = Type.Script(`{
   name: string,
   email: Options<string, {     // Internally calls to Options(...) to augment the embedded
     format: 'email',           // type with auxiliary metadata, in this case a format.
     minLength: 4 
   }>
}`)

---

The Options function was an interesting case where Script needed to be able to apply metadata to types, but where I didn't want to invent new TypeScript syntax (as there are no facilities to apply metadata to types in the language). The name Options was selected as TypeBox used this term to describe any additional schema constraints applied to a type. An alternative name may have been Metadata, but figured I'd just go with library terminology, but both terms are valid.

Perhaps you could rename CoreOptions to Metadata ?

[sleewoo]

i'd rather define a global TRefine and replace TRefine< occurences with Options< before passing type literal to Type.Script

import type { TStringOptions, TNumberOptions, TArrayOptions } from "typebox";

declare global {
  type TRefine<
    T,
    O extends T extends string
      ? TStringOptions
      : T extends number
        ? TNumberOptions
        : T extends unknown[]
          ? TArrayOptions
          : unknown,
  > = T;
}