@nextcloud/typings

![REUSE status](https://api.reuse.software/info/github.com/nextcloud-libraries/nextcloud-typings)
![NPM package](https://www.npmjs.com/package/@nextcloud/typings)
![License](https://github.com/nextcloud/nextcloud-typings/blob/master/LICENSE)
![Open issues](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 ///

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 do not exist on all interfaces.