https://github.com/joslarson/typed-bitwig-api

Typescript types definition file for Bitwig Control Surface API.
https://github.com/joslarson/typed-bitwig-api

Last synced: 3 months ago
JSON representation

Typescript types definition file for Bitwig Control Surface API.

• Host: GitHub
• URL: https://github.com/joslarson/typed-bitwig-api
• Owner: joslarson
• License: bsd-3-clause
• Created: 2017-02-09T06:54:07.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2025-09-21T22:53:48.000Z (9 months ago)
• Last Synced: 2025-11-27T12:00:59.718Z (7 months ago)
• Language: TypeScript
• Homepage:
• Size: 1.16 MB
• Stars: 31
• Watchers: 3
• Forks: 6
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# typed-bitwig-api

Typescript types definition file for Bitwig Control Surface API.

## Installation

```bash

$ npm install typed-bitwig-api

```

In your `tsconfig.json` for your project add the following to the `types` list:

```js

{

    ...

    "types": [

        ...,

        "typed-bitwig-api"

    ],

    ...

}

```

## Usage

With the above installation complete, the `host` variable should be seen as available globally (along with `load`, `loadAPI`, `println`, `dump`, etc). API interfaces are made available for reference through the globally accessible `API` namespace. So, for example, if you wrote a function that took an instance of the API's `Transport` object, you would reference it as follows:

```ts

function foo(transport: API.Transport) {

    // ... do something

}

```