# @nextcloud/typings

> Nextcloud TypeScript typings

Latest version **1.10.0** (published 2025-11-07) · GPL-3.0-or-later license · 0 weekly downloads

## Install

```sh
npm install @nextcloud/typings
pnpm add @nextcloud/typings
yarn add @nextcloud/typings
bun add @nextcloud/typings
```

## Health

**Score 60/100 (C)** — status: stable.

Positive: has types; esm support; no vulnerabilities; high maintenance score.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 1.10.0 |
| Published | 2025-11-07 |
| First published | 2019-10-02 |
| Weekly downloads | 0 |
| License | GPL-3.0-or-later |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | ^20.0.0 \|\| ^22.0.0 \|\| ^24.0.0 |
| Dependencies | 1 |
| Unpacked size | 118.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 7 |
| Author | Nextcloud GmbH and Nextcloud contributors |
| Maintainers | icewind1991, skjnldsv, christophwurst, juliushaertl, nickvergessen, artonge, gretadoci, mejo-, susnux |
| Keywords | nextcloud, typescript, types |

## Links

- npm: https://www.npmjs.com/package/@nextcloud/typings
- Repository: https://github.com/nextcloud-libraries/nextcloud-typings
- Homepage: https://github.com/nextcloud-libraries/nextcloud-typings#readme
- Issues: https://github.com/nextcloud-libraries/nextcloud-typings/issues
- npm.io page: https://npm.io/package/@nextcloud/typings

## Dependencies (1)

- [@types/jquery](https://npm.io/package/@types/jquery.md) 3.5.16

## Alternatives

- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads

## Recent versions

- 1.10.0 (latest) — 2025-11-07
- 1.9.1 — 2024-07-05
- 1.9.0 — 2024-06-25
- 1.8.0 — 2024-02-23
- 1.7.0 — 2023-06-14
- 1.6.0 — 2023-01-07
- 1.5.0 — 2022-11-03
- 1.4.3 — 2022-06-14
- 1.4.2 — 2022-05-02
- 1.4.1 — 2022-04-28
- 1.4.0 — 2022-04-27
- 1.3.0 — 2021-12-07
- 1.2.1 — 2021-07-13
- 1.2.0 — 2021-06-29
- 1.0.0 — 2020-08-31
- … 13 more at https://npm.io/package/@nextcloud/typings/versions

## README

<!--
  - SPDX-FileCopyrightText: 2019 Nextcloud GmbH and Nextcloud contributors
  - SPDX-License-Identifier: GPL-3.0-or-later
-->	
# @nextcloud/typings
[![REUSE status](https://api.reuse.software/badge/github.com/nextcloud-libraries/nextcloud-typings)](https://api.reuse.software/info/github.com/nextcloud-libraries/nextcloud-typings)
[![NPM package](https://img.shields.io/npm/v/@nextcloud/typings)](https://www.npmjs.com/package/@nextcloud/typings)
[![License](https://img.shields.io/npm/l/@nextcloud/typings?color=blue)](https://github.com/nextcloud/nextcloud-typings/blob/master/LICENSE)
[![Open issues](https://img.shields.io/github/issues-raw/nextcloud/nextcloud-typings)](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.

---
_Source: https://npm.io/package/@nextcloud/typings · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
