@cord-sdk/api-types NPM | npm.io

1.44.0 • Published 2 days ago

Install

Weekly downloads

-

License

MIT

Repository

Last release

2 days ago

@cord-sdk/api-types ·

This package contains TypeScript type definitions and JSON schema objects for the data types used by the Cord REST API.

Installation

npm install @cord-sdk/api-types

TypeScript Type Definitions

To use proper type definitions for the data structures send to and received from the Cord REST API, import them from this package, e.g.:

import { PlatformUserVariables } from '@cord-sdk/api-types';

Run-Time Validation

You can use the JSON schema shipped in this package to validate data structures send to or received from the Cord REST API at run-time.

For example, to do run-time validation using the AJV package in TypeScript:

import Ajv from "ajv";
import { schema } from '@cord-sdk/api-types';
import type { PlatformUserVariables } from '@cord-sdk/api-types';

const ajv = new Ajv();

const validatePlatformUserVariables = ajv.compile<PlatformUserVariables>(schema['PlatformUserVariables']);

The validatePlatformUserVariables function takes data as an argument and returns a boolean indicating whether the given data conforms to the schema for PlatformUserVariables. The function is declared as a type guard, so if you use it as the conditional in an if statement, TypeScript understands that within the true-branch, the data is of type PlatformUserVariables.

@infinitebrahmanuniverse/nolb-_cor @everything-registry/sub-chunk-198

2 days ago

10 days ago

11 days ago

11 days ago

13 days ago

18 days ago

18 days ago

18 days ago

1.41.1-canary.4

19 days ago

1.41.1-canary.3

19 days ago

1.41.1-canary.2

19 days ago

1.41.1-canary.0

19 days ago

1.41.1-canary.1

20 days ago

23 days ago

24 days ago

26 days ago

1.38.1-canary.0

27 days ago

1 month ago

1.37.1-canary.0

1 month ago

1.37.1-canary.1

1 month ago

1.37.1-canary.2

1 month ago

1 month ago

1.36.3-canary.4

1 month ago

1.36.3-canary.3

1 month ago

1.36.3-canary.2

2 months ago

1.36.3-canary.0

2 months ago

1.36.3-canary.1

2 months ago

1.36.2-canary.4

2 months ago

1.36.2-canary.3

2 months ago

2 months ago

1.36.2-canary.0

2 months ago

1.36.2-canary.2

2 months ago

1.36.2-canary.1

2 months ago

2 months ago

1.36.1-canary.2

2 months ago

1.36.1-canary.3

2 months ago

1.36.1-canary.0

2 months ago

1.36.1-canary.1

2 months ago

1.36.1-canary.5

2 months ago

1.35.4-canary.0

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

1.35.1-canary.0

2 months ago

2 months ago

1.34.5-canary.1

3 months ago

1.34.5-canary.0

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

10 months ago

8 months ago

8 months ago

11 months ago

8 months ago

7 months ago

8 months ago

9 months ago

9 months ago

9 months ago

7 months ago

7 months ago

6 months ago

6 months ago

7 months ago

6 months ago

9 months ago

8 months ago

8 months ago

10 months ago

8 months ago

7 months ago

7 months ago

8 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

7 months ago

7 months ago

7 months ago

6 months ago

6 months ago

6 months ago

6 months ago

6 months ago

9 months ago

12 months ago

12 months ago

12 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

1 year ago

1 year ago

1 year ago

1 year ago

11 months ago

11 months ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago