@flatkit/types 0.19.10 → 0.19.12
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +29 -0
- package/package.json +3 -3
package/README.md
ADDED
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# @flatkit/types
|
|
2
|
+
|
|
3
|
+
Shared TypeScript types for the [FlatInk](http://flatink.zwyk-studio.com/) animation format — `Doc`,
|
|
4
|
+
`Layer`, `Item`, `Timeline`, `Path`, and friends. The **leaf** of the
|
|
5
|
+
[`flatkit`](https://github.com/flatink/flatkit) dependency graph: zero runtime, zero dependencies.
|
|
6
|
+
|
|
7
|
+
You rarely install this directly — [`@flatkit/engine`](https://www.npmjs.com/package/@flatkit/engine),
|
|
8
|
+
[`@flatkit/player`](https://www.npmjs.com/package/@flatkit/player), and
|
|
9
|
+
[`@flatkit/compiler`](https://www.npmjs.com/package/@flatkit/compiler) re-export the types you need. Reach
|
|
10
|
+
for it when you want to type a `.flatpack` document on its own.
|
|
11
|
+
|
|
12
|
+
## Install
|
|
13
|
+
|
|
14
|
+
```sh
|
|
15
|
+
pnpm add -D @flatkit/types
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
## Usage
|
|
19
|
+
|
|
20
|
+
```ts
|
|
21
|
+
import type { Doc, Layer, Text } from '@flatkit/types'
|
|
22
|
+
|
|
23
|
+
const doc: Doc = JSON.parse(flatpackJson)
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
## License
|
|
27
|
+
|
|
28
|
+
[MIT](https://github.com/flatink/flatkit/blob/main/LICENSE) (c) Zwyk Studio — part of
|
|
29
|
+
[flatkit](https://github.com/flatink/flatkit).
|
package/package.json
CHANGED
|
@@ -1,16 +1,16 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@flatkit/types",
|
|
3
|
-
"version": "0.19.
|
|
3
|
+
"version": "0.19.12",
|
|
4
4
|
"description": "Shared types for the FlatInk format (Doc, Layer, Item, …). The leaf of the dependency graph.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"author": "Zwyk Studio",
|
|
7
7
|
"homepage": "http://flatink.zwyk-studio.com/",
|
|
8
8
|
"repository": {
|
|
9
9
|
"type": "git",
|
|
10
|
-
"url": "git+https://github.com/
|
|
10
|
+
"url": "git+https://github.com/flatink/flatkit.git",
|
|
11
11
|
"directory": "packages/types"
|
|
12
12
|
},
|
|
13
|
-
"bugs": "https://github.com/
|
|
13
|
+
"bugs": "https://github.com/flatink/flatkit/issues",
|
|
14
14
|
"keywords": [
|
|
15
15
|
"flatink",
|
|
16
16
|
"flatpack",
|