Interface NBTSchemaToTypeScriptInterfaceConversionOptions

Options for converting NBT schemas to TypeScript interfaces.

See

nbtSchemaToTypeScriptType

interface NBTSchemaToTypeScriptInterfaceConversionOptions {
    allowExtraArrayItems?: boolean;
    allowExtraProps?: boolean;
    emitHelperTypes?: boolean;
    inlineRefs?: boolean;
    originalSymbolReference?: string | string[];
    refLookup?: Record<string, string | NBTSchema | NBTSchemaFragment>;
    schemaIDToSymbolNameResolver(schemaID: string): string;
}

Properties

allowExtraArrayItems? allowExtraProps? emitHelperTypes? inlineRefs? originalSymbolReference? refLookup?

Methods

schemaIDToSymbolNameResolver?

Properties

OptionalallowExtraArrayItems

allowExtraArrayItems?: boolean

Allows extra array items in lists.

Todo

This is currently bugged.

Default

false

OptionalallowExtraProps

allowExtraProps?: boolean

Allows extra properties in compounds.

Todo

This is currently bugged.

Default

false

OptionalemitHelperTypes

emitHelperTypes?: boolean

Emit named type aliases for union branches.

Todo

This is currently bugged.

Default

true

OptionalinlineRefs

inlineRefs?: boolean

Whether to inline references to other NBT schemas.

Default

false

OptionaloriginalSymbolReference

originalSymbolReference?: string | string[]

The values to put in the @see TSDoc comment of the TypeScript interface.

OptionalrefLookup

refLookup?: Record<string, string | NBTSchema | NBTSchemaFragment>

Lookup for NBT schemas for the $ref property of NBT schemas.

Default

nbtSchemas

Example: To make refs in the schemas stay as a ref, referencing the other types:

writeFileSync(
    path.join(import.meta.dirname, "./nbtSchemaTypeScriptTypes.d.ts"),
    Object.entries(NBTSchemas.nbtSchemas)
        .map(([name, schema]) =>
            NBTSchemas.Utils.Conversion.ToTypeScriptType.nbtSchemaToTypeScriptType(schema, "DataTypes_" + name, {
                originalSymbolReference: `NBTSchemas.nbtSchemas.${name}`, // This makes the generated types have a clickable link to go to the original NBT schema.
            })
        )
        .join("\n\n")
);

Methods

OptionalschemaIDToSymbolNameResolver

  • schemaIDToSymbolNameResolver(schemaID: string): string

    Lookup for NBT schema TypeScript types from the $ref property of NBT schemas.

    Parameters

    • schemaID: string

      The ID of the NBT schema.

    Returns string

    The symbol name of the TypeScript interface.

    Default

    (schemaID: string) => schemaID

Settings

Member Visibility

On This Page

Properties
Methods