json-typescript

JSON.ts

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

How to use this

1. Install this package

npm install --save-dev json-typescript

1. Include this module in your tsconfig.json's typeRoots

{
  "compilerOptions": {
    "typeRoots": [
      "node_modules/@types",
      "node_modules/json-typescript"
    ]
  },
  "exclude": [
    "node_modules"
  ]
}

1. check to see if json types are validated correctly

// ✅ 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

© 2017 Mike North, All Rights Reserved.