README.md

JSONAPI-typescript

TypeScript type information for compile-time validation of JSON:API documents. Supports TS 2.3 and above.

How to use this

1. Install this package

npm install --save-dev jsonapi-typescript

2. Import this module

import * as JSONAPI from 'jsonapi-typescript';

3. check to see if json types are validated correctly

import * as JSONAPI from 'jsonapi-typescript';

// ✅ This should be OK
let doc: JSONAPI.Document = {
  data: {
    type: 'articles',
    id: '1'
  }
};

// ⛔️ This should NOT be OK ("result" is not a valid JSON:API top-level key)
let doc: JSONAPI.Document = {
  result: "Success!"
};

// ⛔️ This should NOT be OK ( empty Array is not a valid JSON:API document )
let doc: JSONAPI.Document = [];

Copyright

© 2017 Mike North, All Rights Reserved.