tanu

library0.6.2jsnpmunverified

Tanu.js is a JavaScript/TypeScript library designed to simplify the generation of TypeScript types and interfaces by providing a high-level, declarative abstraction over the complex TypeScript Compiler API. It specifically aims to mitigate the common practice of generating `.d.ts` files using error-prone, untyped template literal strings, promoting greater type safety and readability in generated code. Currently at version 0.2.0, the library is in an early, active development phase, implying potential for rapid evolution and API changes. Its key differentiator is a fluent API for defining TypeScript constructs like interfaces, enums, and types, including a sophisticated mechanism for handling self-referencing and cross-referencing types through lazy evaluation callback functions.

type-stubs

npm install tanu

package ↗

INSTALL

IMPORT

SIG · TANU

tanu

type-stubsjavascriptv0.6.2

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

✓ import { t } from 'tanu.js';

✗ const t = require('tanu.js');

Tanu.js is published as an ESM-first library. While some bundlers might transpile CommonJS 'require', direct usage is generally discouraged in favor of native ES Modules.

t.interface

✓ import { t } from 'tanu.js'; const MyInterface = t.interface('MyInterface', { /* ... */ });

✗ import { interface } from 'tanu.js';

Type definition functions like 'interface', 'enum', 'array', etc., are methods of the main 't' object and are not top-level named exports.

t.generate

✓ import { t } from 'tanu.js'; const result = await t.generate([/* ... */]);

✗ import { generate } from 'tanu.js';

The 'generate' function is a method of the 't' object and is typically used asynchronously to produce the final TypeScript string output.

Demonstrates defining several TypeScript interfaces and an enum, including nested and optional types, and then generating the corresponding TypeScript source code.

import { t } from 'tanu.js'; const User = t.interface('User', { id: t.number(), email: t.string(), name: t.optional({ first: t.string(), last: t.string() }) }); const MemberRole = t.enum('MemberRole', [ 'DEFAULT', 'PRIVILEGED', 'ADMINISTRATOR' ]); const Member = t.interface('Member', { user: User, role: MemberRole }); const Organization = t.interface('Organization', { name: t.comment(t.string(), [ 'The organization name.', '@see https://example.com/organization-name' ]), description: t.optional(t.string()), members: t.array(Member) }); async function generateTypes() { const result = await t.generate([User, MemberRole, Member, Organization]); console.log(result); } generateTypes();

Debug

Known issues

gotchaAs of version 0.2.0, Tanu.js is an early-stage library. Its API surface may undergo significant changes and breaking modifications in future minor or patch releases until it reaches a stable 1.0.0 version.

fix

Refer to the latest documentation and changelog for updates, and lock to exact dependency versions for production applications.

affects: >=0.2.0

gotchaWhen defining interfaces or types that are self-referencing or mutually recursive (e.g., a 'User' interface that contains an array of 'User' objects), it is crucial to use the callback pattern for `t.interface` or `t.type` to enable lazy evaluation. Failing to do so will result in runtime errors.

fix

Wrap your type definition object in an arrow function, for example: `t.interface('MyType', () => ({ selfRef: MyType }))`.

affects: >=0.2.0

Errors

Common errors & fixes

ReferenceError: Cannot access 'MyType' before initialization

Attempting to define a self-referencing or mutually recursive type without utilizing the lazy evaluation callback function for `t.interface` or `t.type`.

fix

Wrap the type definition object in an arrow function to allow for lazy resolution of the type reference: `const MyType = t.interface('MyType', () => ({ prop: MyType }));`

Error: Module not found: Can't resolve 'tanu.js' in '...' OR Cannot find module 'tanu.js' from '...'

The `tanu.js` package has not been installed or is not correctly resolved by your module bundler/Node.js environment.

fix

Ensure the package is installed: `npm install tanu.js` or `yarn add tanu.js`. Check your `package.json` for correct installation.

Upgrade

Version history

0.6.2latest on npm

Audit

Dependencies

typescriptrequiredTanu.js is an abstraction layer over the TypeScript Compiler API and therefore requires 'typescript' to be available in the project's dependencies or peer dependencies for full functionality.

Agent activity

22 hits · last 30 days

node

OpenAI (training)

Resources

packagehttps://www.npmjs.com/package/tanu ↗