Classes

PCB

The main class that represents the entire circuit.

import { PCB } from '@typecad/typecad';
let typecad = new PCB('typecad_concepts', {thickness: 1.6, copper_thickness: 35 });

Optional properties are: {thickness: 1.6, copper_thickness: 35 }

• thickness — board thickness in mm
• copper_thickness — copper thickness in microns (1 oz = 35 microns)

These are used in power-aware calculations.

The PCB class is where:

• Components are added
• Connections are made between components
• Board layout is defined
• Utility functions like ERC and BOM
• Routing with route() and autorouteBatch()
• Zones, keepout areas, and graphics

Component

The Component class represents individual parts like resistors, capacitors, ICs, etc. You add a Component to your PCB.

import { Component } from '@typecad/typecad';

let R1 = new Component({ value: '1kohm' });

• reference — reference designator
• value — value of component
• footprint — footprint
• symbol — KiCAD symbol library path
• prefix — prefix for reference designator
• datasheet — link to component datasheet
• description — description of component
• voltage — voltage rating of component
• wattage — wattage rating of component
• mpn — Manufacturer Part Number
• dnp — true if component is Do Not Populate, false to place component
• simulation — an object with simulation data { include: true, model: 'ngspice-model' }
• pcb — position on the board { x, y, rotation }
• text — array of arbitrary text entries on the board, each with property, text, position, and styling
• fab — fabrication layer text entry; accepts a positioning object or [text, positioning] tuple
• referenceLayout — controls reference designator text position and style (defaults to F.SilkS layer)
• valueLayout — controls value text position and style (defaults to F.Fab layer)
• fabLayout — controls fabrication text position and style (defaults to F.Fab layer); text defaults to ${REFERENCE} if omitted

All three layout properties accept an ITextPositioning object and can be set at construction or assigned after creation:

import { Component } from '@typecad/typecad';

let r1 = new Component({
  footprint: 'Resistor_SMD:R_0603_1608Metric',
  reference: 'R1',
  referenceLayout: { x: 0, y: -1.5, rotation: 90, width: 0.8, height: 0.8 },
  valueLayout: { x: 0, y: 1.5, width: 0.6, height: 0.6 },
  fabLayout: { x: 0, y: 0, text: 'R1' },
});

// Or assign after creation:
r1.referenceLayout = { x: 2, y: -1, rotation: 0 };

ITextPositioning Fields

fabLayout extends ITextPositioning with an optional text field (string) that defaults to ${REFERENCE}.

Power

Represents a power source like a battery or voltage regulator.

import { Power } from '@typecad/typecad';

let coin_cell = new Power({ power: holder.pin(1), gnd: holder.pin(2), voltage: 3.7 });

• power — pin on a component that supplies power
• gnd — pin on a component that supplies ground
• voltage — voltage of power source
• current — current capacity of the power source
• direction — output for power sources, input for power consumers

Package

Abstract base class for creating reusable, importable hardware modules. Extend this class to encapsulate a circuit sub-design (e.g. a voltage regulator, sensor module, or MCU subsystem).

import { Package, Component } from '@typecad/typecad';

export class MyResistor extends Package {
  declare resistor: Component;

  build(options) {
    this.resistor = new this.passives.Resistor({ value: '10kohm' });
    this.resistor.pcb = { x: 100, y: 100, rotation: 0 };
  }
}

The constructor handles offset positioning (x, y), auto-collects all Component properties set on this, groups them on the PCB.

TrackBuilder

Fluent API for creating tracks on the PCB:

import { PCB, TrackBuilder } from '@typecad/typecad';

let pcb = new PCB('tracks');

let track: TrackBuilder = pcb
  .track()
  .powerInfo({ current: 1.0, maxTempRise: 10, thickness: 35 })
  .from({ x: 100, y: 100 }, 'F.Cu', 0.2)
  .to({ x: 110, y: 100 })
  .via({ size: 0.8, drill: 0.4 })
  .to({ x: 110, y: 120, layer: 'B.Cu' });

pcb.create();