telestion-client-types

Telestion Client Common TypeScript Definitions

npm: @wuespace/telestion-client-types

Common, useful TypeScript definitions for use in projects in Telestion Client projects.

This package is included in PSCs bootstrapped using the Telestion Client CLI by default.

Installation

First, add it as a development dependency to your project:

pnpm add -D @wuespace/telestion-client-types
# or
npm install --save-dev @wuespace/telestion-client-types

Please also check that you have installed a supported version of @types/react to use this package.

After the installation, check out the provided types:

import { Dashboard } from '@wuespace/telestion-client-types';

const myDashboard: Dashboard = {
	title: 'My Dashboard',
	columns: 4,
	rows: 4,
	widgets: []
};

Every exported type from this package also has an appropriate PropType member exported in @wuespace/telestion-client-prop-types.

For all full list of types used in Telestion Client, check out the reference: https://wuespace.github.io/telestion-client/@wuespace/telestion-client-types/

For the equivalent PropTypes, check out the reference here: https://wuespace.github.io/telestion-client/@wuespace/telestion-client-prop-types/

Package structure

.
├── sample (samples for the types, useful for testing the types)
│   ├── sample.ts
│   ├── sample-js.js
│   └── tsconfig.json
├── src
│   ├── index.ts
│   └── [...]
├── types (built in build script)
│   ├── index.d.ts
│   └── [...]
├── CHANGELOG.md (DO NOT TOUCH! auto-generated changelog for the package)
├── LICENSE
├── package.json
├── README.md (you're here :P)
└── [...] (configuration files, etc.)

Contributing

If you want to contribute to this package, please take a look at the Telestion Client monorepo that manages this package, among other Telestion Client packages.

Contributors

Thank you to all contributors of this repository:

Made with contributors-img.

About

This is part of Telestion, a project by WüSpace e.V..