json-typescript

JSON-typescript

TypeScript type information for compile-time validation of JSON objects.

How to use this

1. Install this package

npm install --save-dev json-typescript

1. Import this package

import _JSON from 'json-typescript';

1. Check to see if json types are validated correctly

import _JSON from 'json-typescript';

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

// ⛔️ This should NOT be OK ( functions are not allowed )
let doc: _JSON.Value = {
  foo() {
    return bar;
  }
};

// ⛔️ This should NOT be OK ( Array is not a JSON.Object )
let doc: _JSON.Object = [];

Copyright

© 2018 Mike North, All Rights Reserved.