Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

bug: Optional values in fixed length arrays not supported

See original GitHub issue

Command

yarn ts-interface-builder src/components/folder/folder/PreviewTextAdModel.ts

Error

yarn run v1.17.3
$ /Users/folder/folder/folder/folder/node_modules/.bin/ts-interface-builder src/components/folder/folder/PreviewTextAdModel.ts
/Users/folder/folder/folder/folder/node_modules/ts-interface-builder/dist/index.js:85
        throw new Error(`Node ${ts.SyntaxKind[node.kind]} not supported by ts-interface-builder: ` +
        ^

Error: Node JSDocNullableType not supported by ts-interface-builder: string?
    at Compiler.compileNode (/Users/folder/folder/folder/folder/node_modules/ts-interface-builder/dist/index.js:85:15)
    at Array.map (<anonymous>)
    at Compiler._compileTupleTypeNode (/Users/folder/folder/folder/folder/node_modules/ts-interface-builder/dist/index.js:148:43)
    at Compiler.compileNode (/Users/folder/folder/folder/folder/node_modules/ts-interface-builder/dist/index.js:51:55)
    at Compiler.compileOptType (/Users/folder/folder/folder/folder/node_modules/ts-interface-builder/dist/index.js:89:32)
    at Compiler._compilePropertySignature (/Users/folder/folder/folder/folder/node_modules/ts-interface-builder/dist/index.js:101:27)
    at Compiler.compileNode (/Users/folder/folder/folder/folder/node_modules/ts-interface-builder/dist/index.js:45:63)
    at /Users/folder/folder/folder/folder/node_modules/ts-interface-builder/dist/index.js:167:30
    at Array.map (<anonymous>)
    at Compiler._compileInterfaceDeclaration (/Users/folder/folder/folder/folder/node_modules/ts-interface-builder/dist/index.js:167:14)
error Command failed with exit code 1.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.

Interface

interface PreviewTextAdModel {
  finalUrl: string;
  host: string;
  headlines: [string, string, string?];
  paths: [string?, string?];
  descriptions: [string, string?];
}

Problem

[string, string, string?] => 0: string, 1: string, 2: string or undefined

Current “workaround”

interface PreviewTextAdModel {
  finalUrl: string;
  host: string;
  headlines: [string, string] | [string, string, string];
  paths: [] | [string] | [string, string];
  descriptions: [string] | [string, string];
}

Produces

PreviewTextAdModel-ti.ts

/**
 * This module was automatically generated by `ts-interface-builder`
 */
import * as t from 'ts-interface-checker';
// tslint:disable:object-literal-key-quotes

export const PreviewTextAdModel = t.iface([], {
  finalUrl: 'string',
  host: 'string',
  headlines: t.union(t.tuple('string', 'string'), t.tuple('string', 'string', 'string')),
  paths: t.union(t.tuple(), t.tuple('string'), t.tuple('string', 'string')),
  descriptions: t.union(t.tuple('string'), t.tuple('string', 'string'))
});

const exportedTypeSuite: t.ITypeSuite = {
  PreviewTextAdModel
};
export default exportedTypeSuite;