README.md

GoodData Typings

TypeScript interfaces used in UI SDK

Getting started

Usage

With yarn installed, go to your project directory and run

$ yarn add -D @gooddata/typings

If you prefer npm run

$ npm install --save-dev @gooddata/typings

Documentation

Documentation

Develop

Install Node.js and Yarn (for versions, see config).

Install dependencies:

yarn install --frozen-lockfile

Running the development

To develop, you need to run the typescript compiler. By running yarn dev, the typescript compiler will be run in watch mode.

$ cd gooddata-typings
$ yarn dev

Running tests

To run tests (including watch mode), use yarn test.

$ yarn test

Deployment

Use gooddata-typings CI job.

Contributing

Report bugs and features on our issues page.

License

Copyright (C) 2007-2022, GoodData(R) Corporation. All rights reserved.

For more information, please see LICENSE and NOTICE