@nldoc/event-types

NLdoc Event Specification Types

This repository contains the event specification types for the NLdoc project.

Installation

Add to your .npmrc file:

@nldoc:registry=https://gitlab.com/api/v4/packages/npm/

Then run:

npm install @nldoc/event-types

Usage

import { DoneEvent } from '@nldoc/event-types'

const typedEvent: DoneEvent = await DoneEvent.parseAsync(event)

Development

Project structure

The project is structured as follows:

• src/: Contains the TypeScript source files.
  • src/__test__/: Contains the test helpers for the TypeScript source files.
  • src/**/*.spec.ts: Contains the tests for the TypeScript source files.
  • src/events.ts: Contains the Event types as documented in the Specification.
• dist/: Contains the compiled JavaScript files.

Writing new types

When writing new types, they would go into src/events.ts.

Testing

The types in this package are tested against the collection of examples (valid and invalid) that were provided in the NLdoc event specification. These examples will be downloaded to the local filesystem on first run of the tests.

To run the tests, run:

$ npm test

License

See LICENSE.txt for the license of this repository.