Typed Query Builder

Typed query builder is based on Query Builder, it has the same runtime behavior but you can benefit from type safety and better type hints by TypeScript.

Usage same to Query Builder.

Differences from non-typed query builder

Typed query build is based on query build, this means that they have a completely consistent runtime behavior. But for type safety and better type hints, some usage will be marked as type error by TypeScript.

Selection

In non-typed query builder, these are allowed:

gqfn([
  {
    users: $ => $([ // you can omit the arguments if you don't need it
      'id',
    ])
  }
])

gqfn([
  {
    users: $ => $({}, [ // or pass a empty object
      'id',
    ])
  }
])

But in typed query builder, you need to pass the arguments if the field can accept arguments, if you don't need it, you can pass a empty object:

gqfn([
  {
    users: $ => $({}, [
      'id',
    ])
  }
])

If you need to add directives, you need to pass a empty object even the field don't accept arguments:

gqfn([
  {
    allUsers: $ => $({}, [
      'id',
    ], [
      ['@skip', { if: true }],
    ])
  }
])