Partial Query

Use gqfp to reuse common fields like GraphQL Fragments.

Example

Query Builder

const userFields = gqfp(
  'fragment UserFields',
  'on Users',
  [
    'id',
    'name',
  ],
)

const query = gqfn([
  {
    user: $ => $({ id: 1 }, [{
      ...userFields($),
      friends: $ => $([
        userFields($), // if you don't need more fields
      ]),
    }]),
  },
])

GraphQL Query

{
  user(id: 1) {
    name
    id
    friends {
      name
      id
    }
  }
}

Fragments vs Partial Query

Partial Query is a typed package of GraphQL Fragments. On the base of Fragment, we add the type check for Variables.

Type Definition

export function gqfp(
  name: 'fragment' | `fragment ${string}`,
  base: `on ${string}`,
  selection: TypeSelection,
): ($: Dollar<any>) => SelectionObject
export function gqfp(
  name: 'fragment' | `fragment ${string}`,
  base: `on ${string}`,
  vars: Variables,
  selection: TypeSelection,
): ($: Dollar) => SelectionObject

interface SelectionObject {
  [key: string]:
    | true
    | (($: Dollar) => DollarContext<TypeSelection>)
}