PeerTube/packages/types/README.md

# PeerTube typings

These **Typescript** *types* are mainly used to write **PeerTube** plugins.

## Installation

Npm:
```
npm install --save-dev @peertube/peertube-types
```

Yarn:
```
yarn add --dev @peertube/peertube-types
```

## Usage

> See [contribute-plugins](https://docs.joinpeertube.org/contribute/plugins?id=typescript) **Typescript** section of the doc.
refactor(types): create dedicated folder for types package src fix guide examples and add types package readme refactor(tsconfig): move back base tsconfig to base directory 2021-11-09 13:49:08 +01:00			`# PeerTube typings`

			`These Typescript types are mainly used to write PeerTube plugins.`

			`## Installation`

			`Npm:`
			```
			`npm install --save-dev @peertube/peertube-types`
			```

			`Yarn:`
			```
			`yarn add --dev @peertube/peertube-types`
			```

			`## Usage`

Move to new documentation links 2023-02-22 16:15:14 +01:00			`> See [contribute-plugins](https://docs.joinpeertube.org/contribute/plugins?id=typescript) Typescript section of the doc.`