Skip to main content

@freesewing/core

FreeSewing's core package holds the core library for parametric design of sewing patterns.

It is published on NPM as @freesewing/core .
The source code for this package is available in our monorepo on Codeberg under packages/core .

tip

Refer to the core API reference documentation for in-depth info on how to use this package.

note

This package does not provide a default export.

Installation​

npm install --save @freesewing/core

Named Exports​

Attributes​

The constructor method for Attributes.

import { Attributes } from '@freesewing/core'

beamIntersectsCircle​

The beamIntersectsCircle function.

import { beamIntersectsCircle } from '@freesewing/core'

beamIntersectsCurve​

The beamIntersectsCurve function.

import { beamIntersectsCurve } from '@freesewing/core'

beamIntersectsX​

The beamIntersectsX function.

import { beamIntersectsX } from '@freesewing/core'

beamIntersectsY​

The beamIntersectsY function.

import { beamIntersectsY } from '@freesewing/core'

beamsIntersect​

The beamsIntersect function.

import { beamsIntersect } from '@freesewing/core'

Bezier​

A copy of the BezierJs library.

import { Bezier } from '@freesewing/core'

capitalize​

The capitalize function.

import { capitalize } from '@freesewing/core'

cbqc​

The cbqc number, which is the ideal value to approximate a quarter circle with a cubic Bezier curve.

tip

cbqc stands for Cubic Bezier Quarter Circle

import { capitalize } from '@freesewing/core'

circlesIntersect​

The circlesIntersect function.

import { circlesIntersect } from '@freesewing/core'

curveEdge​

The curveEdge function.

import { curveEdge } from '@freesewing/core'

curveIntersectsX​

The curveIntersectsX function.

import { curveIntersectsX } from '@freesewing/core'

curveIntersectsY​

The curveIntersectsY function.

import { curveIntersectsY } from '@freesewing/core'

curvesIntersect​

The curvesIntersect function.

import { curvesIntersect } from '@freesewing/core'

deg2rad​

The deg2rad function.

import { deg2rad } from '@freesewing/core'

Design​

The constructor method for Design.

import { Design } from '@freesewing/core'

generateStackTransform​

The generateStackTransform function.

import { generateStackTransform } from '@freesewing/core'

getTransformedBounds​

The getTransformedBounds function.

import { getTransformedBounds } from '@freesewing/core'

goldenRatio​

The goldenRatio number, which is the ideal value to approximate a quarter circle with a cubic Bezier curve.

hidePresets​

The hidePresets object holds presets for hiding parts in a FreeSewing design.

import { hidePresets } from '@freesewing/core'

lineIntersectsCircle​

The lineIntersectsCircle function.

import { lineIntersectsCircle } from '@freesewing/core'

lineIntersectsCurve​

The lineIntersectsCurve function.

import { lineIntersectsCurve } from '@freesewing/core'

linesIntersect​

The linesIntersect function.

import { linesIntersect } from '@freesewing/core'

mergeI18n​

The mergeI18n function.

import { mergeI18n } from '@freesewing/core'

mergeOptions​

The mergeOptions function.

import { mergeOptions } from '@freesewing/core'

Part​

The constructor method for Part.

import { Part } from '@freesewing/core'

Path​

The constructor method for Path.

import { Path } from '@freesewing/core'

Pattern​

The constructor method for Pattern.

import { Pattern } from '@freesewing/core'

pctBasedOn​

The pctBasedOn function.

import { pctBasedOn } from '@freesewing/core'

Point​

The constructor method for Point.

import { Point } from '@freesewing/core'

pointOnBeam​

The pointOnBeam function.

import { pointOnBeam } from '@freesewing/core'

pointOnCurve​

The pointOnCurve function.

import { pointOnCurve } from '@freesewing/core'

pointOnLine​

The pointOnLine function.

import { pointOnLine } from '@freesewing/core'

rad2deg​

The rad2deg function.

import { rad2deg } from '@freesewing/core'

round​

The round function.

import { round } from '@freesewing/core'

Snippet​

The constructor method for Snippet.

import { Snippet } from '@freesewing/core'

splitCurve​

The splitCurve function.

import { splitCurve } from '@freesewing/core'

Store​

The constructor method for Store.

import { Store } from '@freesewing/core'

stretchToScale​

The stretchToScale function.

import { stretchToScale } from '@freesewing/core'

units​

The units function.

import { units } from '@freesewing/core'

version​

The version of the FreeSewing core library.

import { version } from '@freesewing/core'