UNPKG

@nextcloud/typings

Version:

Nextcloud TypeScript typings

github.com/nextcloud/nextcloud-typings

nextcloud/nextcloud-typings

29 lines (18 loc) • 1.38 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
# @nextcloud/typings [![NPM package](https://img.shields.io/npm/v/@nextcloud/typings?style=for-the-badge)](https://www.npmjs.com/package/@nextcloud/typings) [![License](https://img.shields.io/npm/l/@nextcloud/typings?color=green&style=for-the-badge)](https://github.com/nextcloud/nextcloud-typings/blob/master/LICENSE) [![Open issues](https://img.shields.io/github/issues-raw/nextcloud/nextcloud-typings?style=for-the-badge)](https://github.com/nextcloud/nextcloud-typings/issues) Versioned typings for the (internal) JavaScript APIs of Nextcloud used in higher level packages. ## Installation ```sh npm i -S @nextcloud/typings ``` The typings have to be in the ``dependencies`` section, not ``devDependencies``. See https://www.typescriptlang.org/docs/handbook/declaration-files/publishing.html#dependencies for details. ## Usage You can use this package to verify your API usage is compatible with a range of Nextcloud versions ```ts /// <reference types="@nextcloud/typings" /> declare var OC: Nextcloud.v26.OC | Nextcloud.v27.OC | Nextcloud.v28.OC; OC.L10N.translate("app", "text") ``` The TypeScript compiler will translate the code above to `OC.L10N.translate("app", "text");` and throws an error if any of the Nextcloud versions in use for the [union type](https://www.typescriptlang.org/docs/handbook/advanced-types.html#union-types) do not exist on all interfaces.