Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@neuledge/typescript-states

neuledge14Apache-2.00.2.2TypeScript support: included

State code generator for Neuledge Engine in TypeScript

typescript, state, code, generator, neuledge, engine

readme

Neuledge Typescript States

A TypeScript code generator for Neuledge Engine "*.states" files.

This library is not intended to be used directly. It is a dependency of the main package.

📦 Installation

npm install @neuledge/typescript-states

🚀 Getting started

import { generate } from '@neuledge/typescript-states';
import { StatesContext } from '@neuledge/states';
import { promises as fs } from 'fs';

// create a state context and load a state file
const ctx = new StatesContext();
await ctx.load([{
  source: await fs.readFile('posts.states', { encoding: 'utf8' }),
  filePath: 'posts.states',
}]);

// generate TypeScript code from the state context
await fs.writeFile('states.generated.ts', generate(ctx));

📄 License

Neuledge is Apache 2.0 licensed.