freesewing/markdown/dev/reference/api/en.md

title	for	icons	about
Core API	developers	javascript terms	FreeSewing's core API reference documents all available methods and objects

This is the documentation for FreeSewing's core library, published as @freesewing/core on NPM. It's a complete toolbox for parametric design with a primary focus on sewing patterns, but can be utilized for a variety of similar 2D design tasks.

Getting started

To get started, import the library:

import freesewing from '@freesewing/core'

This is the reference documentation. For a more hands-on walkthrough, please refer to our pattern design tutorial

Properties

The @freesewing/core default export is a single object with the following properties:

• Design: The Design constructor to create a new design

You will typically use the Design() constructor.
The other constructors and utilities below are exported to facilitate unit testing.

• Path: The Path constructor to create a new path
• Pattern: The Pattern constructor to create a new pattern
• Point: The Point constructor to create a new point
• Snippet: The Snippet constructor to create a new snippet
• utils: A collection of utilities
• version: A string containing the @freesewing/core version number