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
The npm package jsonapi-typescript receives a total of 3,398 weekly downloads. As such, jsonapi-typescript popularity was classified as popular.
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
The Socket Research team breaks down a malicious npm package targeting the legitimate DOMPurify library. It uses obfuscated code to hide that it is exfiltrating browser and crypto wallet data.
Security News
ENISA’s 2024 report highlights the EU’s top cybersecurity threats, including rising DDoS attacks, ransomware, supply chain vulnerabilities, and weaponized AI.
Security News
NIST's new password guidelines remove periodic changes and special character requirements, focusing on longer, more secure passwords for better authentication practices.