ts-budgie/src/nodes/aliaser.ts

Converts TypeScript code to Budgie.

import * as ts from "typescript";

import { BudgieLine } from "../output/budgieLine";

/**
 * Literals that may refer to a node's privacy.
 */
export type IPrivacyName = "private" | "protected" | "public";

/**
 * A node type that contains a return type.
 */
export type IReturningNode = ts.ArrowFunction | ts.MethodDeclaration | ts.MethodSignature | ts.FunctionDeclaration;

/**
 * Generates Budgie-friendly names for node types.
 */
export interface INodeAliaser {
    /**
     * Generates a Budgie-friendly name for a node's type.
     *
     * @param node   Node to generate a type name of.
     * @returns Budgie-equivalent output type name of the node, if possible.
     */
    getFriendlyTypeName(node: ts.Node): string | BudgieLine | undefined;
}