ciiu-arl 1.0.0 → 1.0.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 +32 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# risk-classification
|
|
2
|
+
|
|
3
|
+
Exports the `risk-classification.json` dataset and TypeScript types for risk classification codes, as published in the [ciiu-arl](https://www.npmjs.com/package/ciiu-arl) npm package.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
npm install ciiu-arl
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Usage
|
|
12
|
+
|
|
13
|
+
### Import the JSON data
|
|
14
|
+
|
|
15
|
+
```js
|
|
16
|
+
import riskClassification from "ciiu-arl/risk-classification.json" with { type: "json" };
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
### Import the TypeScript types
|
|
20
|
+
|
|
21
|
+
```ts
|
|
22
|
+
import type { RiskClassification } from "ciiu-arl/types";
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
## Files exported
|
|
26
|
+
|
|
27
|
+
- `risk-classification.json`: The risk classification dataset
|
|
28
|
+
- `types.ts`: TypeScript types for the dataset
|
|
29
|
+
|
|
30
|
+
## License
|
|
31
|
+
|
|
32
|
+
ISC
|