@helia/interface 3.0.1-3477b27 → 3.0.1-4943c5b
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 +14 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -11,6 +11,20 @@
|
|
|
11
11
|
|
|
12
12
|
> The Helia API
|
|
13
13
|
|
|
14
|
+
# About
|
|
15
|
+
|
|
16
|
+
The API defined by a Helia node
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```typescript
|
|
21
|
+
import type { Helia } from '@helia/interface'
|
|
22
|
+
|
|
23
|
+
export function doSomething(helia: Helia) {
|
|
24
|
+
// use helia node functions here
|
|
25
|
+
}
|
|
26
|
+
```
|
|
27
|
+
|
|
14
28
|
# Install
|
|
15
29
|
|
|
16
30
|
```console
|
package/package.json
CHANGED