[![npm version][npm-image]][npm-url]
[![downloads][downloads-image]][npm-url]
[![build status][build-image]][build-url]
[![coverage status][coverage-image]][coverage-url]
[![Node.JS version][node-version]][node-url]

core-types-ts

This package provides conversion functions between [core-types][core-types-github-url] and TypeScript.

You probably don't want to use this package directly, but rather [typeconv][typeconv-github-url] which uses this package to convert between TypeScript, JSON Schema and GraphQL.

See

Other conversion packages:
* [core-types-json-schema][core-types-json-schema-github-url]
* [core-types-graphql][core-types-graphql-github-url]
* [core-types-suretype][core-types-suretype-github-url] (which is also using this package)

Versions

Since 4.0, this package is pure ESM and requires Node 14.13.1 or later.

Contents

- core-types-ts
- See
- Versions
- Contents
- Usage
- core-types to TypeScript
- TypeScript to core-types

Usage

There are two conversion functions, convertCoreTypesToTypeScript and convertTypeScriptToCoreTypes, both returning a wrapped value, of the type ConversionResult.

core-types to TypeScript

``ts
import { convertCoreTypesToTypeScript } from 'core-types-ts'

let doc; // This core-types document comes from somewhere

const { data: tsSourceCode } = convertCoreTypesToTypeScript( doc );
`

You can provide options as a second argument fn the type:

`ts
interface ToTsOptions
{
warn?: WarnFunction;
filename?: string;
sourceFilename?: string;
useUnknown?: boolean;
declaration?: boolean;
userPackage?: string;
userPackageUrl?: string;
noDisableLintHeader?: boolean;
noDescriptiveHeader?: boolean;
namespaces?: 'ignore'| 'dot'| 'underscore'| 'all';
unsupported?: 'ignore' | 'warn' | 'error';
}
`

These options are all optional.

* warn: A function callback to be used for warnings, defaults to console.warn.
* filename The filename to be written to.
This is a hint, no file will be written by the conversion function.
* sourceFilename: The name of the source file from which the core-types comes.
useUnknown: Use unknown rather than any for any*-types.
* declaration: Write a declaration file, where e.g. "export interface" becomes "export declare interface".
* userPackage: The name of the package using this package.
* userPackageUrl: The url to the package using this package.
* noDisableLintHeader: Prevent writing the "disable linting" comment.
* noDescriptiveHeader: Do no write a top-level descriptive comment about the auto-generated file
* namespaces: Try to reconstruct namespaces
* ignore: Don't try to reconstruct namespaces (default)
* dot: Split names by dot (.) as namespaces for top-level types
* underscore: Split names by underscore (_) as namespaces for top-level types
* all: Split by dot (.) and/or underscores (_) as namespaces for top-level types
* unsupported: What to do when detecting an unsupported type
* ignore: Ignore (skip) type
* warn: Ignore type, but warn (default)
* error: Throw an error

The warn function is of type WarnFunction from [core-types][core-types-github-url], meaning it takes a message as string, and an optional second argument of type CoreTypesErrorMeta, also from [core-types][core-types-github-url].

TypeScript to core-types

`ts
import { convertTypeScriptToCoreTypes } from 'core-types-ts'

let sourceCode; // This source code comes from somewhere

const { data: doc } = convertTypeScriptToCoreTypes( sourceCode );
`

An optional second argument can be provided on the form

`ts
interface FromTsOptions
{
warn?: WarnFunction;
namespaces?: 'ignore' | 'hoist' | 'join-dot' | 'join-underscore';
nonExported?: 'fail' | 'ignore' | 'include' | 'inline' | 'include-if-referenced';
unsupported?: 'ignore' | 'warn' | 'error';
}
`

* warn: The same warn function as in CoreTypesToGraphqlOptions
* namespaces: How to deal with namespaces
*ignore: Ignore namespaces entirely (default)
* hoist: Hoist types inside namespaces to top-level, so that the types are included, but without their namespace. This can cause conflicts, in which case deeper declarations will be dropped in favor of more top-level declarations. Same-level will be exported non-deterministically.
* join-dot: Join namespaces and types with a dot (.)
* join-underscore: Join namespaces and types with an underscore (_)
* nonExported: How to handle references to non-exported types
* fail: Fail conversion with an Error
* ignore: Don't include non-exported types, but allow references to them
* include: Include non-exported types
* inline: Don't include non-exported types, inline them if necessary.
Will throw an Error if the inlined types have cyclic dependencies.
* include-if-referenced: Include non-exported types only if they are referenced
from exported types (default)
* unsupported: What to do when detecting an unsupported type
* ignore: Ignore (skip) type (default)
* warn: Ignore type, but warn
* error`: Throw an error

[npm-image]: https://img.shields.io/npm/v/core-types-ts.svg
[npm-url]: https://npmjs.org/package/core-types-ts
[downloads-image]: https://img.shields.io/npm/dm/core-types-ts.svg
[build-image]: https://img.shields.io/github/actions/workflow/status/grantila/core-types-ts/master.yml?branch=master
[build-url]: https://github.com/grantila/core-types-ts/actions?query=workflow%3AMaster
[coverage-image]: https://coveralls.io/repos/github/grantila/core-types-ts/badge.svg?branch=master
[coverage-url]: https://coveralls.io/github/grantila/core-types-ts?branch=master
[node-version]: https://img.shields.io/node/v/core-types-ts
[node-url]: https://nodejs.org/en/

[typeconv-github-url]: https://github.com/grantila/typeconv
[core-types-github-url]: https://github.com/grantila/core-types
[core-types-graphql-github-url]: https://github.com/grantila/core-types-graphql
[core-types-json-schema-github-url]: https://github.com/grantila/core-types-json-schema
[core-types-suretype-github-url]: https://github.com/grantila/core-types-suretype