# @omnisci/omniscidb-thrift-ts-bindings

> OmnisciDB Thrift TypeScript bindings

Latest version **0.0.3** (published 2021-12-23) · MIT license · 0 weekly downloads

## Install

```sh
npm install @omnisci/omniscidb-thrift-ts-bindings
pnpm add @omnisci/omniscidb-thrift-ts-bindings
yarn add @omnisci/omniscidb-thrift-ts-bindings
bun add @omnisci/omniscidb-thrift-ts-bindings
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.3 |
| Published | 2021-12-23 |
| First published | 2021-10-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 1.1 MB |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| Maintainers | israelvicars, ravenhurst, mapd-core |

## Links

- npm: https://www.npmjs.com/package/@omnisci/omniscidb-thrift-ts-bindings
- Repository: https://github.com/omnisci/omniscidb-thrift-ts-bindings
- Homepage: https://github.com/omnisci/omniscidb-thrift-ts-bindings#readme
- Issues: https://github.com/omnisci/omniscidb-thrift-ts-bindings/issues
- npm.io page: https://npm.io/package/@omnisci/omniscidb-thrift-ts-bindings

## Dependencies (2)

- [thrift](https://npm.io/package/thrift.md) ^0.14.2
- [node-int64](https://npm.io/package/node-int64.md) ^0.4.0

## Recent versions

- 0.0.3 (latest) — 2021-12-23
- 0.0.2 — 2021-10-29
- 0.0.1 — 2021-10-02

## README

# omniscidb-thrift-ts-bindings
OmnisciDB Thrift TypeScript bindings

### How to update bindings
* Install docker
* Clone https://github.com/omnisci/omniscidb to your local
* From the root folder of `omniscidb` run the following command:
`docker run -v $PWD:/data --user $(id -u):$(id -g) -it cspwizard/thrift:0.14.2 -r -gen js:ts,node,es6 -o /data /data/omnisci.thrift`
* This should have generated a folder `gen-nodejs`
* There are 4 lines in `OmniSci.d.ts` that will have generated invalid TypeScript optional arguments ordering. Search for the following and just make them optional arguments:
  * `file_type?: TFileType, create_params: TCreateParams` -> `file_type?: TFileType, create_params?: TCreateParams`
  * `first_n?: number, transport_method: TArrowTransport` -> `first_n?: number, transport_method?: TArrowTransport`
* Copy the contents of the `/gen-nodejs` folder into this repo's `lib/thrift` folder and commit those changes.

### How to publish package to NPM
// TODO - write steps for package publishing

---
_Source: https://npm.io/package/@omnisci/omniscidb-thrift-ts-bindings · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._