open-index/open-npm huggingface dataset:
npm package: @lcpcode/plugin-typings
Description: Typings for the Lcpcode Plugin API
Author: lcpcode
Latest version: 0.0.2

# lcpcode Plugin API typings

[![npm](https://img.shields.io/npm/v/@lcpcode/plugin-typings?logo=npm&cacheSeconds=1800)](https://www.npmjs.com/package/@lcpcode/plugin-typings)

This repository contains the typings for the lcpcode Plugin API.

## Usage

1. Installation

   ```sh
   npm i --save-dev @lcpcode/plugin-typings
   # or
   yarn add -D @lcpcode/plugin-typings
   ```

2. Configure _tsconfig.json_

   ```js
   {
       "compilerOptions": {
           "typeRoots": [
               "./node_modules/@types",
               "./node_modules/@lcpcode"
           ]
       }
   }
   ```

   The configuration above is needed for the TypeScript compiler to use type definitions found in both `./node_modules/@types` and `./node_modules/@lcpcode`. Normally, most external type definitions are from DefinitelyTyped and are installed in `/@types`, which included by TypeScript by default. Since we host the plugin typings separately, they are installed outside in `/@lcpcode` instead.

   Types should become globally available without needing to use import statements. We do it this way because the plugin API is part of the host environment, as opposed to being a package that a plugin includes.

## About

Plugin API releases have the format "Version X, Update Y". Equivalent tags are created in this repository as `v<x>.<y>`. Note that not all API releases include API changes, some are just bug fixes. Therefore, some typings versions are skipped.