1.47.2 • Published 1 year ago

@cord-sdk/api-types v1.47.2

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

@cord-sdk/api-types · GitHub license npm version

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.

1.46.1-canary.0

1 year ago

1.47.1-canary.1

1 year ago

1.47.1-canary.3

1 year ago

1.47.1-canary.2

1 year ago

1.46.2-canary.0

1 year ago

1.46.2-canary.1

1 year ago

1.46.0

1 year ago

1.46.2

1 year ago

1.46.1

1 year ago

1.47.1

1 year ago

1.47.0

1 year ago

1.47.2

1 year ago

1.44.1-canary.3

1 year ago

1.44.1-canary.2

1 year ago

1.44.1-canary.5

1 year ago

1.45.1

1 year ago

1.45.0

1 year ago

1.44.1-canary.1

1 year ago

1.44.0

1 year ago

1.43.1

1 year ago

1.42.4

1 year ago

1.43.0

1 year ago

1.42.3

1 year ago

1.42.0

1 year ago

1.42.2

1 year ago

1.42.1

1 year ago

1.41.1-canary.4

1 year ago

1.41.1-canary.3

1 year ago

1.41.1-canary.2

1 year ago

1.41.1-canary.0

1 year ago

1.41.1-canary.1

1 year ago

1.41.0

1 year ago

1.40.0

1 year ago

1.39.0

1 year ago

1.38.1-canary.0

1 year ago

1.38.0

1 year ago

1.37.1-canary.0

1 year ago

1.37.1-canary.1

1 year ago

1.37.1-canary.2

1 year ago

1.37.0

1 year ago

1.36.3-canary.4

1 year ago

1.36.3-canary.3

1 year ago

1.36.3-canary.2

1 year ago

1.36.3-canary.0

1 year ago

1.36.3-canary.1

1 year ago

1.36.2-canary.4

1 year ago

1.36.2-canary.3

1 year ago

1.36.2

1 year ago

1.36.2-canary.0

1 year ago

1.36.2-canary.2

1 year ago

1.36.2-canary.1

1 year ago

1.36.1

1 year ago

1.36.1-canary.2

1 year ago

1.36.1-canary.3

1 year ago

1.36.1-canary.0

1 year ago

1.36.1-canary.1

1 year ago

1.36.1-canary.5

1 year ago

1.35.4-canary.0

1 year ago

1.36.0

1 year ago

1.35.3

1 year ago

1.35.2

1 year ago

1.35.1

1 year ago

1.35.1-canary.0

1 year ago

1.35.0

1 year ago

1.34.5-canary.1

1 year ago

1.34.5-canary.0

1 year ago

1.34.4

1 year ago

1.34.2

1 year ago

1.34.3

1 year ago

1.34.1

1 year ago

1.34.0

1 year ago

1.33.0

1 year ago

1.32.0

1 year ago

1.31.1

1 year ago

1.31.2

1 year ago

1.31.0

1 year ago

1.30.2

1 year ago

1.30.3

1 year ago

1.30.1

2 years ago

1.30.0

2 years ago

1.29.0

2 years ago

1.28.1

2 years ago

1.28.0

2 years ago

1.27.2

2 years ago

1.27.0

2 years ago

1.27.1

2 years ago

1.2.0

2 years ago

1.14.0

2 years ago

1.12.1

2 years ago

1.0.0

2 years ago

1.12.0

2 years ago

1.18.0

2 years ago

1.16.0

2 years ago

1.8.0

2 years ago

1.6.0

2 years ago

1.4.0

2 years ago

1.21.0

2 years ago

1.21.1

2 years ago

1.25.0

2 years ago

1.25.1

2 years ago

1.23.0

2 years ago

1.25.2

2 years ago

1.11.0

2 years ago

1.15.0

2 years ago

1.13.1

2 years ago

1.1.0

2 years ago

1.13.0

2 years ago

1.19.0

2 years ago

1.17.0

2 years ago

1.15.1

2 years ago

1.9.0

2 years ago

1.7.0

2 years ago

1.5.1

2 years ago

1.5.0

2 years ago

1.3.0

2 years ago

1.20.1

2 years ago

1.22.0

2 years ago

1.20.0

2 years ago

1.24.1

2 years ago

1.26.0

2 years ago

1.24.0

2 years ago

1.26.1

2 years ago

1.26.2

2 years ago

1.10.0

2 years ago

0.0.40

2 years ago

0.0.41

2 years ago

0.0.42

2 years ago

0.0.43

2 years ago

0.0.44

2 years ago

0.0.45

2 years ago

0.0.46

2 years ago

0.0.47

2 years ago

0.0.37

2 years ago

0.0.38

2 years ago

0.0.39

2 years ago

0.0.36

2 years ago

0.0.48

2 years ago

0.0.49

2 years ago

0.0.34

2 years ago

0.0.35

2 years ago

0.0.32

2 years ago

0.0.33

2 years ago

0.0.31

2 years ago

0.0.30

2 years ago

0.0.29

2 years ago

0.0.28

2 years ago

0.0.27

2 years ago

0.0.26

3 years ago

0.0.25

3 years ago

0.0.24

3 years ago

0.0.23

3 years ago

0.0.22

3 years ago