From c8bb376da2c34392df6987fcbbb6165f49912532 Mon Sep 17 00:00:00 2001 From: "aegir[bot]" Date: Sat, 7 Oct 2023 10:14:28 +0000 Subject: [PATCH] docs: update documentation [skip ci] --- assets/highlight.css | 35 ---------------------- assets/search.js | 2 +- functions/dagCbor-1.html | 15 +++++----- index.html | 34 ++++++++------------- interfaces/AddOptions.html | 50 ++++++++++++++++++++++++------- interfaces/DAGCBOR.html | 25 ++++++++-------- interfaces/DAGCBORComponents.html | 15 +++++----- interfaces/GetOptions.html | 50 ++++++++++++++++++++++++------- modules.html | 11 ++++--- 9 files changed, 123 insertions(+), 114 deletions(-) diff --git a/assets/highlight.css b/assets/highlight.css index 1ab6cef..2db395a 100644 --- a/assets/highlight.css +++ b/assets/highlight.css @@ -15,16 +15,6 @@ --dark-hl-6: #DCDCAA; --light-hl-7: #008000; --dark-hl-7: #6A9955; - --light-hl-8: #800000; - --dark-hl-8: #808080; - --light-hl-9: #800000; - --dark-hl-9: #569CD6; - --light-hl-10: #000000FF; - --dark-hl-10: #D4D4D4; - --light-hl-11: #E50000; - --dark-hl-11: #9CDCFE; - --light-hl-12: #0000FF; - --dark-hl-12: #CE9178; --light-code-background: #FFFFFF; --dark-code-background: #1E1E1E; } @@ -38,11 +28,6 @@ --hl-5: var(--light-hl-5); --hl-6: var(--light-hl-6); --hl-7: var(--light-hl-7); - --hl-8: var(--light-hl-8); - --hl-9: var(--light-hl-9); - --hl-10: var(--light-hl-10); - --hl-11: var(--light-hl-11); - --hl-12: var(--light-hl-12); --code-background: var(--light-code-background); } } @@ -55,11 +40,6 @@ --hl-5: var(--dark-hl-5); --hl-6: var(--dark-hl-6); --hl-7: var(--dark-hl-7); - --hl-8: var(--dark-hl-8); - --hl-9: var(--dark-hl-9); - --hl-10: var(--dark-hl-10); - --hl-11: var(--dark-hl-11); - --hl-12: var(--dark-hl-12); --code-background: var(--dark-code-background); } } @@ -72,11 +52,6 @@ --hl-5: var(--light-hl-5); --hl-6: var(--light-hl-6); --hl-7: var(--light-hl-7); - --hl-8: var(--light-hl-8); - --hl-9: var(--light-hl-9); - --hl-10: var(--light-hl-10); - --hl-11: var(--light-hl-11); - --hl-12: var(--light-hl-12); --code-background: var(--light-code-background); } @@ -89,11 +64,6 @@ --hl-5: var(--dark-hl-5); --hl-6: var(--dark-hl-6); --hl-7: var(--dark-hl-7); - --hl-8: var(--dark-hl-8); - --hl-9: var(--dark-hl-9); - --hl-10: var(--dark-hl-10); - --hl-11: var(--dark-hl-11); - --hl-12: var(--dark-hl-12); --code-background: var(--dark-code-background); } @@ -105,9 +75,4 @@ .hl-5 { color: var(--hl-5); } .hl-6 { color: var(--hl-6); } .hl-7 { color: var(--hl-7); } -.hl-8 { color: var(--hl-8); } -.hl-9 { color: var(--hl-9); } -.hl-10 { color: var(--hl-10); } -.hl-11 { color: var(--hl-11); } -.hl-12 { color: var(--hl-12); } pre, code { background: var(--code-background); } diff --git a/assets/search.js b/assets/search.js index 1b1dd4e..0c069e8 100644 --- a/assets/search.js +++ b/assets/search.js @@ -1 +1 @@ -window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA42VTY+bMBCG/4tz9RLMN7lts9Kqp5V66AWhisXOBi1gBGxbCfHfO0DIYNUQLpEm87yvx54x7kgt/zTkFHXkMys5OXkOJWVSCHIiPPk4v8uaUPJV5xBfvsq0zWTZHG+ZJ2Zc2yIHIM2TphHgQ0hPZyvL9e5eL8+v529vP86yqGQpyra5u2ZlK+pLkorm+B+0ac9MC2t9z2X62bSyFvuND4posQYlVVIDpq1bv79nzt+q8XB062N2/46uSXMV9Q63w53Ub2FRmr72V9Fu1I7Z/bWnkot0h9lhBvWVLwrbnKqNlm8PqOkEd6+E80c+h4nZnJQ1+w/RPrSfmAf2MQU9F3/JqSO/Rd3A8UDaMmwjBP6SiZwP93laF9xkUQwO8S33U6Qw8AMxIUeT0MikzDEC5sUxjWbFmBj/GDEGEaMsNELLUTCmYBZElg6zFMyGyNZhtoI5EDk6zFEwFyJXh7kK5kHk6TBPwfy1A/EVLIDI17kFCgZNiQIdFo7Y2E1oYyv496mr0JdxzDry69Znfx6ijgTw0/fY1SEaTEEh5yuMQhuF9opw+QlEoYVCa0V4u7mo8VDjrWjg2UjHBwVVJqrMgaPE3xanixcEbRjasBX9eLlQEaAiXFdoDtVFobsinD/IKHJQ5OhEMAZVVok8K4GJ4r7/B7VylviYBwAA"; \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA42VTW+jMBCG/4tz9RJsPgK5tVmp6qnSHvYSoRXFToMKGAHtroT47zt8ZbBqUi6Rhnne12PP2GlJpf7W5HhuyXtaCHLknk9JEeeSHMmDEC9lk6qiJpR8VBl8SotGVpc4kfUes9a1yTNAkiyuawluhHR0NmQ2d2+O17i+ymqD2+5GLkwpKeNKFo1eGi61rP3nw9Pp8eWXaakpdbdqbrvBzSsW4juf3ciYi51rWbF/k8239iOz2f7rQZxUXqoCBMZefoG2t/Q1U8l73ahKbjfeaaK7u1rUbd7fk2zuDClmt+8oUUImG8x2M2jewKIwXMjHZUT8dnpVeBkuH0Uy4Psp84OZao4olCTkP3JsyaesalDAd245VgjkJZWZ6O/zuApIVZ739URT7rdM4Nh7YkT2NqFnm7LQCrkbRfQ8K4bE8GHAGETMhDEN4xBxylwrYL6GcQ1zIHJMbo6GuRC5JszVMA8iz4R5GuZD5JswX8MOEB1M2EHDAogCExZoWLh2IOGADd2ENjZSPI9dhb4Mb0lL/kx9duaRaYkDP12HXe2j3hQUar4EKLRRaK8IlxcRhT4K/RXhNPuoCVATrGhgrpNh4lHFUcV7jpLwvjhZvGNo46GNt6IfXlBUuKhw1xWGQz2g8LAinP+7UMRQxEwiGIMyLWWWFsCco677D68HoaaYBwAA"; \ No newline at end of file diff --git a/functions/dagCbor-1.html b/functions/dagCbor-1.html index 1002a75..43a6d8a 100644 --- a/functions/dagCbor-1.html +++ b/functions/dagCbor-1.html @@ -1,4 +1,4 @@ -dagCbor | @helia/dag-cbor - v1.0.3
+dagCbor | @helia/dag-cbor - v0.0.0
  • Preparing search index...
    • -
  • The search index is not available
@helia/dag-cbor - v1.0.3
+
  • The search index is not available
    • @helia/dag-cbor - v0.0.0
    @@ -25,14 +25,14 @@

    Function dagCbor

    Parameters

    • -
      helia: {
          blockstore: Blocks;
      }
      +
      helia: {
          blockstore: Blocks;
      }
    +
    blockstore: Blocks

    Returns DAGCBOR

    +
  • Defined in packages/dag-cbor/src/index.ts:118
    • @@ -44,12 +44,11 @@

    Member Visibility

      • -
      • -
    +

    • Theme

    -
    -

    @helia/dag-cbor - v1.0.3

    +

    @helia/dag-cbor - v0.0.0

    Helia logo @@ -23,24 +23,20 @@

    @helia/dag-cbor - v1.0.3

    codecov CI

    -

    Add/get IPLD blocks containing dag-cbor with your Helia node

    +

    Add/get IPLD blocks containing json with your Helia node

    Table of contents

    -

    Install

    $ npm i @helia/dag-cbor
-
    -

    Browser <script> tag

    Loading this module through a script tag will make it's exports available as HeliaDagCbor in the global namespace.

    -
    <script src="https://unpkg.com/@helia/dag-cbor/dist/index.min.js"></script>
-
    +

    Structure

    API Docs

    License

    Licensed under either of

    +

    • Theme

    @@ -78,15 +73,12 @@

    Table of contents -
  • Install
    • -
  • -
    • +
  • Structure
  • API Docs
  • License
  • Contribute

    • -
    @@ -18,12 +18,12 @@

    Interface AddOptions

    Hierarchy

    +
  • Defined in packages/dag-cbor/src/index.ts:39
    • @@ -32,14 +32,41 @@

    Properties

    hasher +onProgress? +signal?

    Properties

    hasher

    -
    hasher: MultihashHasher<number>
    +
  • Defined in packages/dag-cbor/src/index.ts:40
    • +
    +

    Optional onProgress

    +
    onProgress?: ((evt) => void)
    +
    +

    Type declaration

    +
    +
    +

    Optional signal

    +
    signal?: AbortSignal
    @@ -51,17 +78,18 @@

    Member Visibility

      • -
      • -
    +

    • Theme

    On This Page
    +
  • hasher
    • +
  • onProgress
    • +
  • signal
    • -
    @@ -25,7 +25,7 @@

    Hierarchy

    • DAGCBOR
    +
  • Defined in packages/dag-cbor/src/index.ts:51
    • @@ -41,7 +41,7 @@

    Methods

    add

      - +

    • Add an object to your Helia node and get a CID that refers to the block the object has been stored as.

      @@ -52,14 +52,14 @@

      Parameters

    • str: unknown
    • -
      Optional options: Partial<AddOptions>
    -

    Returns Promise<CID<unknown, number, number, Version>>

    +
    Optional options: Partial<AddOptions>
    +

    Returns Promise<CID<unknown, number, number, Version>>

    Example

    import { dagCbor } from '@helia/dag-cbor'

    const d = dagCbor(helia)
    const cid = await d.add({ hello: 'world' })

    console.info(cid)
    // CID(bafyreidykglsfhoixmivffc5uwhcgshx4j465xwqntbmu43nb2dzqwfvae)
    +
  • Defined in packages/dag-cbor/src/index.ts:68

    • get

    Parameters

    +
    Optional options: Partial<GetOptions>

    Returns Promise<T>

    Example

    import { dagCbor } from '@helia/dag-cbor'
    import { CID } from 'multiformats/cid'

    const d = dagCbor(helia)
    const cid = CID.parse('bafyreidykglsfhoixmivffc5uwhcgshx4j465xwqntbmu43nb2dzqwfvae')
    const obj = await d.get(cid)

    console.info(obj)
    // { hello: 'world' }
    +
  • Defined in packages/dag-cbor/src/index.ts:88
    • @@ -98,8 +98,7 @@

    Member Visibility

      • -
      • -
    +

    • Theme

    @@ -109,7 +108,7 @@

    add
  • get

    • -
    @@ -20,7 +20,7 @@

    Hierarchy

    • DAGCBORComponents
    +
  • Defined in packages/dag-cbor/src/index.ts:35
    • @@ -34,9 +34,9 @@

    Properties

    Properties

    blockstore

    -
    blockstore: Blocks
    +
  • Defined in packages/dag-cbor/src/index.ts:36
    • @@ -48,8 +48,7 @@

    Member Visibility

      • -
      • -
    +

    • Theme

    @@ -58,7 +57,7 @@

    blockstore

    -
    @@ -18,12 +18,12 @@

    Interface GetOptions

    Hierarchy

    +
  • Defined in packages/dag-cbor/src/index.ts:43
    • @@ -32,14 +32,41 @@

    Properties

    codec +onProgress? +signal?

    Properties

    codec

    -
    codec: BlockCodec<any, unknown>
    +
  • Defined in packages/dag-cbor/src/index.ts:44
    • +
    +

    Optional onProgress

    +
    onProgress?: ((evt) => void)
    +
    +

    Type declaration

    +
    +
    +

    Optional signal

    +
    signal?: AbortSignal
    @@ -51,17 +78,18 @@

    Member Visibility

      • -
      • -
    +

    • Theme

    On This Page
    +
  • codec
    • +
  • onProgress
    • +
  • signal
    • -
    -

    @helia/dag-cbor - v1.0.3

    +

    @helia/dag-cbor - v0.0.0

    @helia/dag-cbor makes working with DAG-JSON Helia simple & straightforward.

    See the DAGCBOR interface for all available operations.

    @@ -45,12 +45,11 @@

    Member Visibility

      • -
      • -
    +

    • Theme

    -