VSinerva/freesewing
1
0
Fork 0
Code Activity

chore(markdown): Working on v3 docs

Browse source
This commit is contained in:
Joost De Cock 2022-09-20 18:09:28 +02:00
parent 22680fbddc
commit 1f7ba79f81
17 changed files with 433 additions and 272 deletions
Download patch file Download diff file Expand all files Collapse all files

83
markdown/dev/reference/api/en.md
View file

@ -6,37 +6,80 @@ This is the documentation for FreeSewing's core library, published as `@freesewi
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:
```js
import freesewing from '@freesewing/core'
```
<Tip>
This is the reference documentation. For a more hands-on walkthrough,
please refer to our [pattern design tutorial](/tutorials/pattern-design/)
##### Looking to get started?
You are currently browsing the reference documentation.
Please refer to [the quick start guide](/guides/quick) to get started.
</Tip>
## Properties
## Named exports
The `@freesewing/core` default export is a single object with the following properties:
<Note>
- `Design`: The [Design constructor](/reference/api/design/) to create a new design
Ever since version 3 of FreeSewing, we use only named exports, and no default exports.
Refer to [the migration guide](/guides/v3) for more details.
</Note>
The `@freesewing/core` package provides the following named exports:
| Named export | Description |
| ------------ | ------------|
| version | The version of `@freesewing/core` |
| Bezier | A re-export of [the bezier-js dependency](https://www.npmjs.com/package/bezier-js) |
The following named exports are **constructors**:
<Note>
You will typically use the `Design()` constructor.
The other constructors and utilities below are exported to facilitate unit testing.
The other constructors and utilities below are exported to
facilitate unit testing and other specific use cases.
</Note>
- `Path`: The [Path constructor](/reference/api/path) to create a new path
- `Pattern`: The [Pattern constructor](/reference/api/pattern) to create a new pattern
- `Point`: The [Point constructor](/reference/api/point) to create a new point
- `Snippet`: The [Snippet constructor](/reference/api/snippet) to create a new snippet
- `utils`: A collection of [utilities](/reference/api/utils)
- `version`: A string containing the `@freesewing/core` version number
| Named export | Description |
| ------------ | ------------|
| `Design` | The [Design](/reference/api/design) constructor |
| `Attributes` | The [Attributes](/reference/api/attributes) constructor |
| `Pattern` | The [Pattern](/reference/api/pattern) constructor |
| `Point` | The [Point](/reference/api/point) constructor |
| `Path` | The [Path](/reference/api/path) constructor |
| `Part` | The [Part](/reference/api/part) constructor |
| `Snippet` | The [Snippet](/reference/api/snippet) constructor |
| `Store` | The [Store](/reference/api/store) constructor |
The following named exports are **uitility methods**:
| Named export | Description |
| ------------ | ------------|
| `beamIntersectsCircle` | See the [beamIntersectsCircle](/reference/api/utils/beamintersectsCircle) documentation |
| `beamIntersectsX` | See the [beamIntersectsX](/reference/api/utils/beamintersectsX) documentation |
| `beamIntersectsY` | See the [beamIntersectsY](/reference/api/utils/) documentation |
| `beamsIntersect` | See the [beamsIntersect](/reference/api/utils/beamsintersect) documentation |
| `capitalize` | See the [capitalize](/reference/api/utils/capitalize) documentation |
| `circlesIntersect` | See the [circlesIntersect](/reference/api/utils/circlesintersect) documentation |
| `curveEdge` | See the [curveEdge](/reference/api/utils/curveedge) documentation |
| `curveIntersectsX` | See the [curveIntersectsX](/reference/api/utils/curveintersectsX) documentation |
| `curveIntersectsY` | See the [curveIntersectsY](/reference/api/utils/curveintersectsY) documentation |
| `curvesIntersect` | See the [curvesIntersect](/reference/api/utils/curvesintersect) documentation |
| `deg2rad` | See the [deg2rad](/reference/api/utils/deg2rad) documentation |
| `generateStackTransform` | see the [generateStackTransform](/reference/api/utils/generateStackTransform) documentation |
| `lineIntersectsCircle` | See the [lineIntersectsCircle](/reference/api/utils/lineintersectsCircle) documentation |
| `lineIntersectsCurve` | See the [lineIntersectsCurve](/reference/api/utils/lineintersectsCurve) documentation |
| `linesIntersect` | See the [linesIntersect](/reference/api/utils/linesintersect) documentation |
| `pctBasedOn` | See the [pctBasedOn](/reference/api/utils/pctbasedon) documentation |
| `pointOnBeam` | See the [pointOnBeam](/reference/api/utils/pointonbeam) documentation |
| `pointOnCurve` | See the [pointOnCurve](/reference/api/utils/pointoncurve) documentation |
| `pointOnLine` | See the [pointOnLine](/reference/api/utils/pointonline) documentation |
| `rad2deg` | See the [rad2deg](/reference/api/utils/rad2deg) documentation |
| `splitCurve` | See the [splitCurve](/reference/api/utils/splitcurve) documentation |
| `stretchToScale` | See the [stretchToScale](/reference/api/utils/stretchtoscale) documentation |
| `units` | See the [units](/reference/api/utils/units) documentation |