@nextcloud/typings
v1.9.1
Published
Nextcloud TypeScript typings
Downloads
31,803
Maintainers
Keywords
Readme
@nextcloud/typings
Versioned typings for the (internal) JavaScript APIs of Nextcloud used in higher level packages.
Installation
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
/// <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 do not exist on all interfaces.