$headers

Callable

• $headers(properties: ObjectType<Record<string, Node>> | ObjectShape<Record<string, Node>>, options?: SchemaOptions<ObjectOptions>): ObjectType<Record<string, Node>>

---

• Create a new headers instance with the given options.

  Example

  $headers({
    foo: $string
    bar: $integer
  })

  @deprecated

  ---

  Parameters

  • properties: ObjectType<Record<string, Node>> | ObjectShape<Record<string, Node>>

    Key value pairs that define the headers object.

  • optionaloptions: SchemaOptions<ObjectOptions>

    Additional options to pass to the headers.

  Returns ObjectType<Record<string, Node>>