freesewing/sites/dev/docs/reference/api/utils/units/readme.mdx

---
title: utils.units()
---

The `utils.units()` function converts the units `value` you pass it into a
formatted string for the `format` you pass it.

## Signature

```js
string utils.units(float value, string format = 'metric')
```

Format must be either `imperial` or `metric` (the default).

## Notes

A [part's `draft()` function](/reference/api/part/draft) receives a context-aware
`unit()` function that will call this function and pass it the units requested by the user.
Revert "chore: Linting for markdown and js" This reverts commit 1c92e0f655c1b34e4b1f6807914529cc4d82ff81. 2021-10-17 18:26:00 +02:00			`---`
chore(markdown): Updated utils docs for v3 2022-10-01 22:20:43 +02:00			`title: utils.units()`
Revert "chore: Linting for markdown and js" This reverts commit 1c92e0f655c1b34e4b1f6807914529cc4d82ff81. 2021-10-17 18:26:00 +02:00			`---`
feat: Flat import of markdown repo This is a flat (without history) import of (some of) the content from our markdown module. We've imported this without history because the repo contains our blog posts and showcases posts content prior to porting them to strapi. Since this contains many images, it would balloon the size of this repo to import the full history. Instead, please refer to the history of the (archived) markdown repo at: https://github.com/freesewing/markdown 2021-08-25 16:09:31 +02:00
chore(markdown): Updated utils docs for v3 2022-10-01 22:20:43 +02:00			The `utils.units()` function converts the units `value` you pass it into a
			formatted string for the `format` you pass it.

			`## Signature`

feat: Flat import of markdown repo This is a flat (without history) import of (some of) the content from our markdown module. We've imported this without history because the repo contains our blog posts and showcases posts content prior to porting them to strapi. Since this contains many images, it would balloon the size of this repo to import the full history. Instead, please refer to the history of the (archived) markdown repo at: https://github.com/freesewing/markdown 2021-08-25 16:09:31 +02:00			```js
			`string utils.units(float value, string format = 'metric')`
			```

			Format must be either `imperial` or `metric` (the default).

chore(markdown): Updated utils docs for v3 2022-10-01 22:20:43 +02:00			`## Notes`
feat: Flat import of markdown repo This is a flat (without history) import of (some of) the content from our markdown module. We've imported this without history because the repo contains our blog posts and showcases posts content prior to porting them to strapi. Since this contains many images, it would balloon the size of this repo to import the full history. Instead, please refer to the history of the (archived) markdown repo at: https://github.com/freesewing/markdown 2021-08-25 16:09:31 +02:00
chore(markdown): Updated utils docs for v3 2022-10-01 22:20:43 +02:00			A [part's `draft()` function](/reference/api/part/draft) receives a context-aware
			`unit()` function that will call this function and pass it the units requested by the user.