Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update/fix the existing TS declaration file #285

Merged
merged 2 commits into from
Feb 4, 2020
Merged

Commits on Feb 4, 2020

  1. Update/fix the existing TS declaration file

    This commit modernizes/fixes the existing TypeScript declaration
    file as follows:
    
    - The module declaration now better represents how exports are
      currently setup, by using module augmentation to give access to
      helper functions that are added to the `gql` function itself.
    - Backwards compatibility has been maintained by re-exporting helper
      functions.
    - Stronger typing changes; the first param of the `gql` template
      literal is now a read only string based array, and the `gql` return
      type is a `DocumentNode`. We're leveraging TS'
      [import types](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-9.html#import-types)
      functionality to reference the `DocumentNode` type, which will
      help avoid issues like the previously reverted attempts to do this
      in #151 and
      #196.
    - While the new `gql` type changes could in theory be considered
      breaking, they really shouldn't be in practice. Tagged template
      literals enforce the use of an immutable array of strings, which
      means that even though `literals` was `any` before, the param
      should only ever been an array of strings. Along the same lines,
      the `gql` function has only ever returned a `DocumentNode`, so
      moving away from the `any` return type should be pretty safe.
    hwillson committed Feb 4, 2020
    Configuration menu
    Copy the full SHA
    0cebbd0 View commit details
    Browse the repository at this point in the history
  2. Changelog update

    hwillson committed Feb 4, 2020
    Configuration menu
    Copy the full SHA
    08d271a View commit details
    Browse the repository at this point in the history