[github/Chocobozzz/PeerTube.git] / 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#typescript) **Typescript** section of the doc.
Commit	Line	Data
b8fa3e8c	1	# PeerTube typings
	2
	3	These Typescript types are mainly used to write PeerTube plugins.
	4
	5	## Installation
	6
	7	Npm:
	8	```
	9	npm install --save-dev @peertube/peertube-types
	10	```
	11
	12	Yarn:
	13	```
	14	yarn add --dev @peertube/peertube-types
	15	```
	16
	17	## Usage
	18
f44cd95c	19	> See [contribute-plugins](https://docs.joinpeertube.org/contribute/plugins#typescript) Typescript section of the doc.