1
0
Fork 0
freesewing/markdown/dev/tutorials/pattern-design/part2/draft-method/en.md

96 lines
2.4 KiB
Markdown
Raw Normal View History

---
title: A part's draft method
2023-09-30 14:04:18 +02:00
order: 50
---
Time to turn our attention to the draft method of our part.
2023-09-30 14:04:18 +02:00
Inside our `src/bib.mjs` file, this is what it currently looks like:
2023-09-30 14:04:18 +02:00
```src/bib.mjs
2023-09-28 09:11:06 +02:00
function draftBib({ part }) => {
return part
}
```
This is an empty skeleton for a draft method. A draft method should always
return the part object, and that's effectively the only thing it currently
does.
## Destructuring the function parameter
If you're not familiar with the `({ part })` syntax you see above, this is a
technique called *parameter destructuring* or more generally, [object
destructuring](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Destructuring_assignment)
The draft method receives only 1 parameter: An object that holds everything we
need to draft our method. Destructuring is a way to *pull things out of the
object into their own variable*. It saves us a bunch of typing as these two are
equivalent:
2022-10-10 04:50:43 +02:00
<Tabs tabs="Without destructuring, With destructuring">
<Tab>
2023-09-30 14:04:18 +02:00
```src/bib.mjs
function draftBib(props) {
return props.part
}
```
2022-10-10 04:50:43 +02:00
</Tab>
<Tab>
2023-09-30 14:04:18 +02:00
```src/bib.mjs
function draftBib({ part }) {
return part
}
```
2022-10-10 04:50:43 +02:00
</Tab>
</Tabs>
As we'll make our way through this tutorial, we'll need more and more stuff, so
we'll be pulling it out of the object passed to the draft method via
*destructuring*.
<Note>
If you're new to JavaScript, and don't intuitively _get this_, stick with it. It will become second nature soon enough.
</Note>
## Destructuring what we need to start drawing our bib
Change the function to look like this:
2023-09-30 14:04:18 +02:00
```src/bib.mjs
function draftBib({
2022-10-11 01:37:09 +02:00
// highlight-start
Path,
Point,
paths,
points,
2022-10-11 01:37:09 +02:00
// highlight-end
part,
}) {
return part
}
```
That's bunch of new lines, but each of one gives us something we'll use in this
tutorial.
For a complete list of what you can access via destructuring like this, refer
to [the draft method reference documentation](/reference/api/part/draft).
Here's a brief summary of the things we've added above:
- `Path`: The Path constructor, allows us to create new Paths
- `Point`: The Point constructor, allows us to create new Points
- `points`: A container object to hold the part's points
- `paths`: A container object to hold the part's paths
2023-09-30 14:04:18 +02:00
<Tip compact>Remember: Constructures start with a **C**apital letter</Tip>
Long story short: These will make it possible for us to draw points and paths easily.
So let's go ahead and do that.