jsonapi-typescript
Advanced tools
TypeScript type information for compile-time validation of JSON:API documents. Supports TS 2.3 and above.
npm install --save-dev jsonapi-typescript
import * as JSONAPI from 'jsonapi-typescript';
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 = [];
© 2017 Mike North, All Rights Reserved.
FAQs
TypeScript definitions for JSON-API
We found that jsonapi-typescript demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.