1
0
Fork 0

feat: Added package documentation (wip)

This commit is contained in:
joostdecock 2025-04-18 19:19:20 +02:00
parent f734707163
commit 02da928f04
82 changed files with 2248 additions and 466 deletions

View file

@ -0,0 +1,103 @@
---
title: '@freesewing/utils'
---
FreeSewing's **utils** package provides various utility methods.
It is published on NPM as [@freesewing/utils
](https://www.npmjs.com/package/@freesewing/utils).\
The source code for this package is available in [our monorepo on Codeberg
](https://codeberg.org/freesewing/freesewing) under [packages/utils
](https://codeberg.org/freesewing/freesewing/src/branch/develop/packages/utils).
:::note
This package does not provide a default export.
:::
## Installation
```sh
npm install --save @freesewing/utils
```
## Named Exports
### capitalize
### clone
### cloudflareImageUrl
### copyToClipboard
### designOptionType
### distanceAsMm
### formatFraction128
### formatImperial
### formatMm
### formatNumber
### formatPercentage
### fractionToDecimal
### get
### getSearchParam
### hasRequiredMeasurements
### horFlexClasses
### horFlexClassesNoSm
### linkClasses
### measurementAsMm
### measurementAsUnits
### mutateObject
### navigate
### notEmpty
### optionsMenuStructure
### optionType
### orderBy
### pathLength
### patternUrlFromState
### randomLoadingMessage
### round
### roundDistance
### set
### shortDate
### shortUuid
### structureMeasurementsAsDesign
### timeAgo
### unset
### userAvatarUrl
### validateEmail
### validateTld