Maker.js, a Microsoft Garage project, is a JavaScript library for creating and sharing modular line drawings for CNC and laser cutters.

View project on GitHub Star

Api - IKit Interface

An IKit is a model-producing class with some sample parameters. Think of it as a packaged model with instructions on how to best use it.

Hierarchy

  • IKit

Index

Constructors

Properties

Constructors

constructor

  • new IKit(...args: any[]): IModel
  • The constructor. The kit must be "new-able" and it must produce an IModel. It can have any number of any type of parameters.

    Parameters

    • Rest ...args: any[]

    Returns IModel

Properties

Optional metaParameters

metaParameters: IMetaParameter[]

Attached to the constructor is a property named metaParameters which is an array of IMetaParameter objects. Each element of the array corresponds to a parameter of the constructor, in order.

Optional notes

notes: string

Information about this kit, in plain text or markdown format.

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc