Penpot/penpot-plugins
0
Fork 0
mirror of https://github.com/penpot/penpot-plugins.git synced 2025-01-06 14:50:21 -05:00
Code Issues Activity

feat: plugins-data-parser readme

Browse source
This commit is contained in:
María Valderrama 2024-03-04 10:48:15 +01:00
parent dd7b7757f4
commit 4e3c25e3ed
1 changed files with 21 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
libs/plugins-data-parser/README.md
View file

@ -1,7 +1,24 @@
# plugins-data-parser
# Parser
This library was generated with [Nx](https://nx.dev).
This library includes a `parse()` funtion and some parsed models like `ParsedFile` or `ParsedPage`.
## Building
The parse function cleans up and transforms a penpot object into a more typescript friendly object. It returns a `ParsedData` object that can be casted as `ParsedFile` or `ParsedPage`. Note that `ParsedData` is the parent interface and includes all `ParsedFile` and `ParsedPage` properties.
Run `nx build plugins-data-parser` to build the library.
Most of the properties are optional and may or may not be present in your result, you should access them with care.
## Use
Import the parse function and the desired models from plugins data parser.
Example:
```
import { parse, ParsedFile } from 'plugins-parser';
[...]
const parsedFile: ParsedFile = parse(file);
console.log(parsedFile.data.colors?.[0]?.data?.color);
[...]
```