b8f6c11864
Bumps [typescript](https://github.com/microsoft/TypeScript) from 5.5.4 to 5.6.3. - [Release notes](https://github.com/microsoft/TypeScript/releases) - [Changelog](https://github.com/microsoft/TypeScript/blob/main/azure-pipelines.release.yml) - [Commits](https://github.com/microsoft/TypeScript/compare/v5.5.4...v5.6.3) --- updated-dependencies: - dependency-name: typescript dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> |
||
---|---|---|
.github | ||
LICENSES | ||
lib | ||
test | ||
.gitignore | ||
.npmignore | ||
AUTHORS.md | ||
CHANGELOG.md | ||
LICENSE | ||
README.md | ||
REUSE.toml | ||
package-lock.json | ||
package.json | ||
tsconfig.json |
README.md
@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.