gerber-to-svg/index.d.ts

Render individual Gerber / NC drill files as SVGs

// Type definitions for gerber-to-svg 4.0
// Project: https://github.com/tracespace/tracespace
// Definitions by: Mike Cousins <https://mike.cousins.io>

/// <reference types="node" />

import {Parser, Options as ParserOptions} from 'gerber-parser'
import {Plotter, Options as PlotterOptions} from 'gerber-plotter'

declare function gerberToSvg<NodeType = string>(
  gerber: gerberToSvg.GerberSource,
  options?:
    | string
    | gerberToSvg.Options<NodeType>
    | gerberToSvg.Callback<NodeType>,
  done?: gerberToSvg.Callback<NodeType>
): gerberToSvg.Converter<NodeType>

declare namespace gerberToSvg {
  function clone<NodeType = string>(
    converter: Converter<NodeType>
  ): ConverterResult<NodeType>

  function render<NodeType = string>(
    converter: ConverterResult<NodeType>,
    attributes: Record<string, unknown> | string,
    createElement?: CreateElement<NodeType>,
    objectMode?: ObjectMode<NodeType>
  ): NodeType

  type GerberSource = string | Buffer | NodeJS.ReadableStream

  type ObjectMode<NodeType = string> = NodeType extends string
    ? NodeType extends Buffer
      ? false
      : true
    : true

  interface CreateElement<NodeType = string> {
    (
      tag: string,
      attributes: Record<string, unknown>,
      children: Array<NodeType>
    ): NodeType
  }

  interface Converter<NodeType = string>
    extends NodeJS.ReadableStream,
      ConverterResult<NodeType> {
    parser: Parser
    plotter: Plotter
  }

  interface ConverterResult<NodeType = string> {
    id: string
    attributes: Record<string, unknown>
    defs: Array<NodeType>
    layer: Array<NodeType>
    viewBox: Array<number>
    width: number
    height: number
    units: 'in' | 'mm'
  }

  interface Options<NodeType = string> extends ParserOptions, PlotterOptions {
    id?: string
    attributes?: Record<string, unknown>
    createElement?: CreateElement<NodeType>
    objectMode?: ObjectMode<NodeType>
  }

  interface Callback<NodeType = string> {
    (error: Error, result: NodeType): unknown
  }
}

export = gerberToSvg