@transloadit/types 6.1.0 → 6.1.1
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 +10 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,7 +1,15 @@
|
|
|
1
1
|
# @transloadit/types
|
|
2
2
|
|
|
3
|
-
**Stability:**
|
|
3
|
+
**Stability:** Exported names follow strict SemVer. API contract types and schemas
|
|
4
|
+
follow API2 and can change in minor releases, including type-breaking updates. See the
|
|
5
|
+
[versioning policy](https://github.com/transloadit/node-sdk/blob/main/CONTRIBUTING.md#versioning-policy).
|
|
6
|
+
|
|
7
|
+
- Commit your lockfile and type-check dependency update PRs.
|
|
8
|
+
- Use `~` ranges for stable contract types within a minor; patch releases do not change contract
|
|
9
|
+
types. Use `^` to follow the API as it evolves.
|
|
10
|
+
- Use input types for instructions you write, such as `AssemblyInstructionsInput`; narrow fields
|
|
11
|
+
from responses and parsed output before use (`null`, `undefined`, unknown strings).
|
|
4
12
|
|
|
5
13
|
This package provides type-only exports generated from Transloadit schemas.
|
|
6
14
|
|
|
7
|
-
For the
|
|
15
|
+
For the SDK client, use `@transloadit/node` or the unscoped `transloadit` package.
|