# Orbital Client Types

This package contains TypeScript type definitions for Orbital's client.

## Installation

`npm install --save @useorbital/client-types`

## Use

Add the following to your `tsconfig.json`:

```json
{
  "compilerOptions": {
    "typeRoots": ["./node_modules/@types", "./node_modules/@useorbital"]
  }
}
```

or add the following to each of your typescript files that call `orbital(…)`:

```ts
/// <reference path="../node_modules/@useorbital/client-types/index.d.ts"/>
```

replace `..` with the relative path to the node_modules dir

### Local import

If you prefer to use local imports you can do this:

```ts
import type { orbital } from '@useorbital/client-types/types'
```