@getplate/client
v5.5.2
Published
Package containing all the core functionality of Plate Delta, such as PRN and API standards
Downloads
445
Readme
@getplate/client
This package contains the functionality to be shared with JS/TS consumers of Plate Delta.
Some of the functionality that we implement crosses the border of the API. To this end we maintain this client package, which contains all these general purpose functionality.
This also includes shared types, that are used both in backend and frontend.
Examples of features which could be added to this package are:
- API client
- Interfaces for every model
Features
Plate Resource Notation
This package defines a PRN object, which allows for creation from strings conform PRN formatting or separate components.
More info can be found on the Plate Resource Notation Wiki page.
Plate Content Validations
This package also provides common types, interfaces and classes for Content Validations.
More info can be found on the Plate Content Validations.
Other
Constructor
, which is the function signature for a class constructor.ReturnConstructorFunction
, which is a function signature for returning a Constructor (useful for lazy-loading).Primitive
, which is the union of primitive values (including a Date). Also includes a isPrimitiveType function.HeaderKeys
enum, which contains all header keys we use.Stages
enum, which contains all possible Stages.