From 28de23368c8ed63be6beca5bd3623985fd21fd75 Mon Sep 17 00:00:00 2001 From: "aegir[bot]" Date: Wed, 20 Dec 2023 08:21:05 +0000 Subject: [PATCH] docs: update documentation [skip ci] --- assets/highlight.css | 63 +++--- assets/navigation.js | 2 +- assets/search.js | 2 +- assets/style.css | 11 + classes/block.Block.html | 12 +- classes/cid.CID.html | 42 ++-- classes/hashes_digest.Digest.html | 12 +- classes/hashes_hasher.Hasher.html | 12 +- functions/block.create.html | 6 +- functions/block.createUnsafe.html | 6 +- functions/block.decode.html | 4 +- functions/block.encode.html | 4 +- functions/bytes.coerce.html | 2 +- functions/bytes.equals.html | 2 +- functions/bytes.fromHex.html | 2 +- functions/bytes.fromString.html | 2 +- functions/bytes.isBinary.html | 2 +- functions/bytes.toHex.html | 2 +- functions/bytes.toString.html | 2 +- functions/cid.format.html | 2 +- functions/cid.fromJSON.html | 2 +- functions/cid.toJSON.html | 2 +- functions/codecs_json.decode.html | 2 +- functions/codecs_json.encode.html | 2 +- functions/codecs_raw.decode.html | 2 +- functions/codecs_raw.encode.html | 2 +- functions/hashes_digest.create.html | 4 +- functions/hashes_digest.decode.html | 4 +- functions/hashes_digest.equals.html | 2 +- functions/hashes_hasher.from.html | 2 +- functions/index.varint.decode.html | 2 +- functions/index.varint.encodeTo.html | 2 +- functions/index.varint.encodingLength.html | 2 +- functions/link.create.html | 8 +- functions/link.createLegacy.html | 5 +- functions/link.decode.html | 4 +- functions/link.isLink.html | 4 +- functions/link.parse.html | 4 +- functions/traversal.walk.html | 2 +- index.html | 72 +++---- interfaces/bases_interface.BaseCodec.html | 4 + interfaces/bases_interface.BaseDecoder.html | 5 + ....html => bases_interface.BaseEncoder.html} | 7 +- .../bases_interface.CombobaseDecoder.html | 9 + .../bases_interface.MultibaseCodec.html | 6 + ... => bases_interface.MultibaseDecoder.html} | 13 +- .../bases_interface.MultibaseEncoder.html | 10 + .../bases_interface.UnibaseDecoder.html | 10 + interfaces/block_interface.Block.html | 9 + interfaces/block_interface.BlockView.html | 13 ++ interfaces/block_interface.ByteView.html | 166 +++++++++++++++ interfaces/block_interface.Phantom.html | 10 + interfaces/codecs_interface.BlockCodec.html | 6 + ...tml => codecs_interface.BlockDecoder.html} | 8 +- interfaces/codecs_interface.BlockEncoder.html | 5 + interfaces/hashes_hasher.MultihashHasher.html | 12 -- .../hashes_interface.MultihashDigest.html | 11 + .../hashes_interface.MultihashHasher.html | 12 ++ .../hashes_interface.SyncMultihashHasher.html | 17 ++ interfaces/index.BaseCodec.html | 4 - interfaces/index.BaseDecoder.html | 5 - interfaces/index.Block.html | 9 - interfaces/index.BlockCodec.html | 6 - interfaces/index.BlockEncoder.html | 5 - interfaces/index.BlockView.html | 13 -- interfaces/index.ByteView.html | 166 --------------- interfaces/index.CombobaseDecoder.html | 9 - interfaces/index.LegacyLink.html | 16 -- interfaces/index.Link.html | 17 -- interfaces/index.LinkJSON.html | 2 - interfaces/index.MultibaseCodec.html | 6 - interfaces/index.MultibaseDecoder.html | 8 - interfaces/index.MultibaseEncoder.html | 10 - interfaces/index.Phantom.html | 10 - interfaces/index.SyncMultihashHasher.html | 17 -- interfaces/index.UnibaseDecoder.html | 10 - interfaces/link_interface.LegacyLink.html | 16 ++ interfaces/link_interface.Link.html | 17 ++ interfaces/link_interface.LinkJSON.html | 2 + modules/bases_base10.html | 4 +- modules/bases_base16.html | 4 +- modules/bases_base2.html | 4 +- modules/bases_base256emoji.html | 4 +- modules/bases_base32.html | 4 +- modules/bases_base36.html | 4 +- modules/bases_base58.html | 4 +- modules/bases_base64.html | 4 +- modules/bases_base8.html | 4 +- modules/bases_identity.html | 4 +- modules/bases_interface.html | 10 + modules/basics.html | 4 +- modules/block.html | 5 +- modules/block_interface.html | 6 + modules/bytes.html | 4 +- modules/cid.html | 4 +- modules/codecs_interface.html | 5 + modules/codecs_json.html | 5 +- modules/codecs_raw.html | 5 +- modules/hashes_digest.html | 5 +- modules/hashes_hasher.html | 6 +- modules/hashes_identity.html | 4 +- .../hashes_interface.html | 15 +- modules/hashes_sha1.html | 4 +- modules/hashes_sha2.html | 4 +- modules/index.html | 201 +++++++++++++++--- modules/index.varint.html | 4 +- modules/interface.html | 29 +++ modules/link.html | 4 +- modules/link_interface.html | 13 ++ modules/traversal.html | 6 +- types/bases_interface.Multibase.html | 3 + types/block_interface.BlockCursorView.html | 1 + types/codecs_json.ByteView.html | 1 - types/codecs_raw.ByteView.html | 1 - types/hashes_digest.MultihashDigest.html | 1 - types/hashes_hasher.Await.html | 1 - types/index.BlockCursorView.html | 1 - types/index.DAG_PB.html | 1 - types/index.Multibase.html | 3 - types/index.SHA_256.html | 1 - types/index.ToString.html | 1 - types/index.UnknownLink.html | 1 - types/index.Version.html | 1 - types/link_interface.DAG_PB.html | 1 + types/link_interface.SHA_256.html | 1 + types/link_interface.ToString.html | 1 + types/link_interface.UnknownLink.html | 1 + types/link_interface.Version.html | 1 + types/traversal.BlockView.html | 1 - types/traversal.CID.html | 1 - variables/bases_base10.base10.html | 2 +- variables/bases_base16.base16.html | 2 +- variables/bases_base16.base16upper.html | 2 +- variables/bases_base2.base2.html | 2 +- .../bases_base256emoji.base256emoji.html | 2 +- variables/bases_base32.base32.html | 2 +- variables/bases_base32.base32hex.html | 2 +- variables/bases_base32.base32hexpad.html | 2 +- variables/bases_base32.base32hexpadupper.html | 2 +- variables/bases_base32.base32hexupper.html | 2 +- variables/bases_base32.base32pad.html | 2 +- variables/bases_base32.base32padupper.html | 2 +- variables/bases_base32.base32upper.html | 2 +- variables/bases_base32.base32z.html | 2 +- variables/bases_base36.base36.html | 2 +- variables/bases_base36.base36upper.html | 2 +- variables/bases_base58.base58btc.html | 2 +- variables/bases_base58.base58flickr.html | 2 +- variables/bases_base64.base64.html | 2 +- variables/bases_base64.base64pad.html | 2 +- variables/bases_base64.base64url.html | 2 +- variables/bases_base64.base64urlpad.html | 2 +- variables/bases_base8.base8.html | 2 +- variables/bases_identity.identity.html | 2 +- variables/basics.bases.html | 2 +- variables/basics.codecs.html | 2 +- variables/basics.hashes.html | 2 +- variables/bytes.empty.html | 2 +- variables/codecs_json.code.html | 2 +- variables/codecs_json.name.html | 2 +- variables/codecs_raw.code.html | 2 +- variables/codecs_raw.name.html | 2 +- variables/hashes_identity.identity.html | 2 +- variables/hashes_sha1.sha1.html | 2 +- variables/hashes_sha2.sha256.html | 2 +- variables/hashes_sha2.sha512.html | 2 +- 166 files changed, 834 insertions(+), 647 deletions(-) create mode 100644 interfaces/bases_interface.BaseCodec.html create mode 100644 interfaces/bases_interface.BaseDecoder.html rename interfaces/{block.RequiredCreateOptions.html => bases_interface.BaseEncoder.html} (60%) create mode 100644 interfaces/bases_interface.CombobaseDecoder.html create mode 100644 interfaces/bases_interface.MultibaseCodec.html rename interfaces/{index.BaseEncoder.html => bases_interface.MultibaseDecoder.html} (53%) create mode 100644 interfaces/bases_interface.MultibaseEncoder.html create mode 100644 interfaces/bases_interface.UnibaseDecoder.html create mode 100644 interfaces/block_interface.Block.html create mode 100644 interfaces/block_interface.BlockView.html create mode 100644 interfaces/block_interface.ByteView.html create mode 100644 interfaces/block_interface.Phantom.html create mode 100644 interfaces/codecs_interface.BlockCodec.html rename interfaces/{index.BlockDecoder.html => codecs_interface.BlockDecoder.html} (56%) create mode 100644 interfaces/codecs_interface.BlockEncoder.html delete mode 100644 interfaces/hashes_hasher.MultihashHasher.html create mode 100644 interfaces/hashes_interface.MultihashDigest.html create mode 100644 interfaces/hashes_interface.MultihashHasher.html create mode 100644 interfaces/hashes_interface.SyncMultihashHasher.html delete mode 100644 interfaces/index.BaseCodec.html delete mode 100644 interfaces/index.BaseDecoder.html delete mode 100644 interfaces/index.Block.html delete mode 100644 interfaces/index.BlockCodec.html delete mode 100644 interfaces/index.BlockEncoder.html delete mode 100644 interfaces/index.BlockView.html delete mode 100644 interfaces/index.ByteView.html delete mode 100644 interfaces/index.CombobaseDecoder.html delete mode 100644 interfaces/index.LegacyLink.html delete mode 100644 interfaces/index.Link.html delete mode 100644 interfaces/index.LinkJSON.html delete mode 100644 interfaces/index.MultibaseCodec.html delete mode 100644 interfaces/index.MultibaseDecoder.html delete mode 100644 interfaces/index.MultibaseEncoder.html delete mode 100644 interfaces/index.Phantom.html delete mode 100644 interfaces/index.SyncMultihashHasher.html delete mode 100644 interfaces/index.UnibaseDecoder.html create mode 100644 interfaces/link_interface.LegacyLink.html create mode 100644 interfaces/link_interface.Link.html create mode 100644 interfaces/link_interface.LinkJSON.html create mode 100644 modules/bases_interface.html create mode 100644 modules/block_interface.html create mode 100644 modules/codecs_interface.html rename interfaces/index.MultihashDigest.html => modules/hashes_interface.html (50%) create mode 100644 modules/interface.html create mode 100644 modules/link_interface.html create mode 100644 types/bases_interface.Multibase.html create mode 100644 types/block_interface.BlockCursorView.html delete mode 100644 types/codecs_json.ByteView.html delete mode 100644 types/codecs_raw.ByteView.html delete mode 100644 types/hashes_digest.MultihashDigest.html delete mode 100644 types/hashes_hasher.Await.html delete mode 100644 types/index.BlockCursorView.html delete mode 100644 types/index.DAG_PB.html delete mode 100644 types/index.Multibase.html delete mode 100644 types/index.SHA_256.html delete mode 100644 types/index.ToString.html delete mode 100644 types/index.UnknownLink.html delete mode 100644 types/index.Version.html create mode 100644 types/link_interface.DAG_PB.html create mode 100644 types/link_interface.SHA_256.html create mode 100644 types/link_interface.ToString.html create mode 100644 types/link_interface.UnknownLink.html create mode 100644 types/link_interface.Version.html delete mode 100644 types/traversal.BlockView.html delete mode 100644 types/traversal.CID.html diff --git a/assets/highlight.css b/assets/highlight.css index 1b6b8511..1ba66a01 100644 --- a/assets/highlight.css +++ b/assets/highlight.css @@ -1,34 +1,32 @@ :root { - --light-hl-0: #000000; - --dark-hl-0: #D4D4D4; - --light-hl-1: #800000; - --dark-hl-1: #808080; - --light-hl-2: #800000; - --dark-hl-2: #569CD6; - --light-hl-3: #000000FF; - --dark-hl-3: #D4D4D4; - --light-hl-4: #E50000; - --dark-hl-4: #9CDCFE; - --light-hl-5: #0000FF; - --dark-hl-5: #CE9178; - --light-hl-6: #AF00DB; - --dark-hl-6: #C586C0; - --light-hl-7: #001080; - --dark-hl-7: #9CDCFE; - --light-hl-8: #A31515; - --dark-hl-8: #CE9178; - --light-hl-9: #0000FF; - --dark-hl-9: #569CD6; - --light-hl-10: #0070C1; - --dark-hl-10: #4FC1FF; - --light-hl-11: #795E26; - --dark-hl-11: #DCDCAA; - --light-hl-12: #098658; - --dark-hl-12: #B5CEA8; - --light-hl-13: #008000; - --dark-hl-13: #6A9955; - --light-hl-14: #267F99; - --dark-hl-14: #4EC9B0; + --light-hl-0: #AF00DB; + --dark-hl-0: #C586C0; + --light-hl-1: #000000; + --dark-hl-1: #D4D4D4; + --light-hl-2: #001080; + --dark-hl-2: #9CDCFE; + --light-hl-3: #A31515; + --dark-hl-3: #CE9178; + --light-hl-4: #0000FF; + --dark-hl-4: #569CD6; + --light-hl-5: #0070C1; + --dark-hl-5: #4FC1FF; + --light-hl-6: #795E26; + --dark-hl-6: #DCDCAA; + --light-hl-7: #098658; + --dark-hl-7: #B5CEA8; + --light-hl-8: #008000; + --dark-hl-8: #6A9955; + --light-hl-9: #800000; + --dark-hl-9: #808080; + --light-hl-10: #800000; + --dark-hl-10: #569CD6; + --light-hl-11: #000000FF; + --dark-hl-11: #D4D4D4; + --light-hl-12: #E50000; + --dark-hl-12: #9CDCFE; + --light-hl-13: #0000FF; + --dark-hl-13: #CE9178; --light-code-background: #FFFFFF; --dark-code-background: #1E1E1E; } @@ -48,7 +46,6 @@ --hl-11: var(--light-hl-11); --hl-12: var(--light-hl-12); --hl-13: var(--light-hl-13); - --hl-14: var(--light-hl-14); --code-background: var(--light-code-background); } } @@ -67,7 +64,6 @@ --hl-11: var(--dark-hl-11); --hl-12: var(--dark-hl-12); --hl-13: var(--dark-hl-13); - --hl-14: var(--dark-hl-14); --code-background: var(--dark-code-background); } } @@ -86,7 +82,6 @@ --hl-11: var(--light-hl-11); --hl-12: var(--light-hl-12); --hl-13: var(--light-hl-13); - --hl-14: var(--light-hl-14); --code-background: var(--light-code-background); } @@ -105,7 +100,6 @@ --hl-11: var(--dark-hl-11); --hl-12: var(--dark-hl-12); --hl-13: var(--dark-hl-13); - --hl-14: var(--dark-hl-14); --code-background: var(--dark-code-background); } @@ -123,5 +117,4 @@ .hl-11 { color: var(--hl-11); } .hl-12 { color: var(--hl-12); } .hl-13 { color: var(--hl-13); } -.hl-14 { color: var(--hl-14); } pre, code { background: var(--code-background); } diff --git a/assets/navigation.js b/assets/navigation.js index d3afa4ab..a3bf1855 100644 --- a/assets/navigation.js +++ b/assets/navigation.js @@ -1 +1 @@ -window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA62aTVPjOBCG/0u4UkA+N8ONwNayW+zO1AJzmaJSwnGIB8fO2M4wma357ytZjqyPVqsTc+HgfvWkpZZaUosv//Wq+EfVu+w9szIuz8Xf/kXvtLdh1Yp/XeeLbdp8L+fSeraq1imXvCbZonc5OO1FqyRdFHHWu/xi4HTQd1Yk7NlBQcTh4NfTr1PIsQnq2ITu2CTg2OQMInLHTi3OdrOJCyKs1hK7OsB6OiB3dIC7NjgDcH6fxpN4nX9NUNcaDd1DBwo6usf6f8Pr9hAdyyF9MIeB0RzK4bSJzqwZDlbxDyKKKym0DVvQgVxMZBJmtwWG5zhAPxBN49KHgTIGBw4AufeHQGnEn0TaT+qSQRPtkJ5oh4FEO5S50Sa6XaQkWgU7JNGOp1hXx1NyV8fT5yrCHeQ0pQx0eDxdpkn0GuixAkoxscuTEdblyYjcZR0EucdRENHp7GQUXLgKFV64k9G2SIk0rqTQ6O5JMTEQ6NSjz7wp7pucI1OCT8kizqqk2vnc2ttJnrkw2zmFg7mui0lUgq7x7ySXrv+8QdufSIFkjPofRsOLke7BropxB072Eh9ikbzEZYUzlMYHWbFypedCCKI0PogIRhbwRGm8IyLi6AmwoNR2ZIFF+SKOMIAUIIS6nxhBCvCZlebRKzAS4jNpXs1MQJSyslSAmYvpD6baz/8bf9smRby4LmJWxR83VZJnWo94BOJiySIFBPWWn+OJPsq1sCUut1lUN2qA0m4SJiMH8JiVbBnESBUC4wHlQfVjpB0BxBkOkHYH8ERYyeIzKeLxeuPJbDWiNqPzPi4iuAt1e2nHxuDblqWlHyDtCGBZ5Otb/RZiExpBAHFf8QzxglOkBgEl5SzJWLHzY/YKBFLlaHdqM9o81JW9Ap1YUbJwpxX/SEsj/Hc+J/Gbn3CiSXw5+ebqj/mnGcJQAh/hLn5h0e4uyYCkqCiGyEsKMMKt/7r/+E+A0Eh8lL+3aZWIjeimTizAvqlogDRI/T0jU1spShU71o3nnGBCDaWPeX97Nef7AcJqFT7Gg7M6HIgm8VEes9csf8sCk8JU+Vif46LkixPhtAofwzgO7jdt0Z4bsA17mRdrVkGZQjSW1kDeNKe1BWjsaLbCANKK56n6XHX+tQSHsDbOhfHIvFXtNhZnr7GAFx9+64/tEyG0r+osd3s3NteMrYMIoUEQ/jOKDulwUtExhPNKE66CQXuDRHHbewRLYN4pVgLVLVSC0DVSgtE9UIJCiJO8bJz7bnnSPJdmUrTsfWCfpUzSDQA0U5Z3Y5HBN3GWODgNvNcLExu8ZvhjaYLC4fSejk2Q55QMRNR35W540kyK6K1FsiLakG4BoCeiNlC7L5pMqwV2Y7x6Y4lvkjS0WhKaGmIrQ8LQoISKEgR/earhvVt9yuaRClSNl+WK9b0eCiPJO5PieFZzXJjXI+AJrCXRXsCEcAyW83WSVCEJmwvGffAhzcJwFdo5/k2/8O27VX8+vhrYNg8UA73rDyC52gNLjBrr2Aqjhji6wKgxjq4vSoa0mmEawWHy7woGirjHP+RB0l4YYvHLzl2cvXAUiajkaKqb8XvitThzgAldUpUGS+Ez6MYLohpVCOZcdEFYo0JhZrXUxQB1VxcQHCQlCqIIw6TJgjjCQGmyIM48rMMs4LRugpxDv8uBD/0G5jpfP+dgKcXB2VIMC9WbHGArQlEBCKG5ebMGEe712sSoik9okppCEjI89LaUhA1PWlsaxELXDZjqvWsY0E8rllX6edKBNQoMcr/LIsrRWQIBNQZ/zIghMoXhXLctyryAbu16rlOi0KncrhDrKGkLEdRcgCHKHOI4tUmd0hhDDLc2qUMewKq9SwFrkzpIE4RYTm1S5zRGmKGfBFKwTJq6v3/oY4JCdHlNaCGdnhNaTIf3BA1y7IOCiej8otDi3vVJAcC+w5uCRe32qNDCurwqtJSuzwotqeO7QgsKPyzYDwQuQym8COeRAIC0Gh/GfihwIUrhQ/jLezWE+M8DcnkHKFJ0VIWwpgTvgElpzhKrvTQj7TesKP0/X1vR211VsO989rDUjYgy0f/jBDoQtBjfxcDZrow6iE1xnsLc9m8sBYe0hQgFMC5P/wMwqDYQfTAAAA==" \ No newline at end of file +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA62aTW/bOBCG/4tzDdL6S+vm1iSLTRfd3QJJeykWASMrsRpZ8kpyW7fof19QlCV+zAxHpi45hC8fD0fkcDjk55+TOvleTy4nj6JKqlfy7/T15HyyE/VmcjnZFut91v6/elCtF5t6m03OJy9pvp5czs4n8SbN1mWSTy4/Gzgd9FWUqXh0UBBxPvv1769zyLCINCziGxZ5DIsuIOJ8Zpk1jfa7XVIyYY2WOdQZNdIZe6Az2rTZBYDDbVpGybb4kpKmtRq+hQ4UNPSIxX8DNXtO+nLOd+bc4825cqdNdGbNfLZJvjNRm+Q7h7YTaz5wJ9ZMJmN2W2B4jgP0gWgel+8Gjg8GOoA9+iFQHvEHk/aDu2TIQDvnB9q5J9DOVWy0ie4QOYG2gw0JtMsVNdTlij3U5eqxjmkDl6uLTukZ8HL1lKXxi2fEHVCJmUOOFtSQowV7yDoIMi9aXEBEZ7DRwrtwO5R/4UaLfZkxafsy49D45ikx80OQU48/81a0bWqOrBg2peskr9P6gJl1bGdZ5sJs4zoczIVNzOukfBJxgtp4FLCMvBJVcl2sE23hdgCX2Kkt9jLS7JSimyQu1nq48kBbvQ/7ez4M2+op7HWxfSweB5psd6J+4K99VqePg9xsdmHBh1hvd2L9wBDX252oH/iYD7bf7MKyvufWhx1lsUV7/ea36dJZhmlcgasvjSvWort+d0P2P1MCxVhM3yzmrxe6BYc6oQ04O0owxDp9TqqaZnQaDLIR1Ub/ZBCk02AQGRNzjyWdBvWI/JxInJWUpp3Y5+REiimAEhCEZpwUQQnoAJ8V8QvgCflvXjA3AXEmqqoDXLmY6WylO6FMRK2tlKd9HtdpkR8Bqt0kRAsH8DGvxJMXo1QEbN2sbhyj2glAktMA1e4AnA9C7rhSMHTHNT+SHucsGvDFrC1RCj6lyTc+TqpJ5KFO+MRWTAE/bEReF1sWr9V6h3y9L6uiNM1s4zo05l7OiO5IbJX/Zn3eZLtDUr4G0TSTkSgpY3jWNv1VOzXt/9uLrMIBqp0APJXF9lYvz9iEVuBB3NVlmj/TFKUhQGl1leaiPOCYo4KA1AU5nKaZ7O4bylFBxpI4XbvTKk7XvJjhrEqbcKZJsF3y5u0fDx+uCEYnwAjvk2cRH96nObBNdRRDhJI8DH/vP+/++dtDaCUYBU+eHRog9VKdjBmn9lKSKnOIGyRzM6GGEmPe3b59mC2BSlfH6hUY495ZHQ5Ek2CUj/lLXnzLPZPCVGGsT0lZpUVOcHoFxjAS9GMaJftfv7uhUqinotyKGooUsrNq9cRNc1pbgLadjFYUQLXScarJdKmkRymGZj14BINwnHCm9nb0UO1we703waBOozCXU8CQOuoYDZPRMzTw1b5U4MRXXNnI+lZm3txnMDrHzZ2NNCYXWy9CaggEfgDQIQHHAB3DOAy0Li4FPodLYWeYJzlYYsL8Kwmh7pWMcO9KCsO56nT8CitLqOYH1cxysb1NHoO4SboBgNxDsUnyHo5xf5sgv8vRBN8EIYk+4HWsjtPyVDPL67cWyfJ6S7oFgNY+WuonRmeELUeqOOPDq/otb7Syvs1j1fWPVuI77hE7aMdFM0Ztx3HAVidvbVVK7Y/O4kNzwOTfHfL4pN8AOtKbZ/sBqo2Yor6XjSy3mxRnajQcFwZPiWojgKcbPYn3ckMKl+A1tE5SKmLDqDZiOQUfgFiY5ZR+T5Pma/08fhxW8+9T76xcyJmuQlNI6vBnsfwnP/CGCqH5T3xXcDVY57SKIQkyhvF6Cqu7oUBdS1JZH8AUkjzWJzCFJI83Xt9I0fOPDvIfesCrIw1B3xzhl50QyhUPrSxptKDaksYJqC7plFPrSxaDW2EiQbrKS/KvZ0d6ev0Loo5RAYO4I9TAbCyrCobmGBS102JU59oDoPWawRU6jeKv0ZGZFEQE9cMrgBqSVQNkz0VHelJd0QAGVRY1kr+2iNwwaYxTL+81xMl39xrj5Kt7xVCtZkK3gBM6/GxsoJjViPvCSzoKfaw0f36f5M/1hkfs5MCp1MyA0aNe8OstGDRGNuzwgjNihxiQFZusoMzYRY2QHQPQMTJkFxueJbvMwEzZBQZky0OvCTg5r8EcJe81iIG5r8EKyn9N0uk5sMMJyYMN2Di5MIwcIx+GyePkxDB7lLzYRY+VG8PkkPzYIAblyAZptDzZpI6WKxvYUfJlgzhWzmxBA/Nmg4blznrqlIFmyf8GXkN3iJCXND0kKOT3mIBor0FODfQmIvg1TY8bNXAC2BFipkUNe1DTw0Je1PSU0Cc1PSlwBfcg/8HXfhzjMjoFinAeyACQXoNh7EcyLqRTYAj8XriBMN9Kq+XtoSjRSVfLDcV7bE4rc5ZY/VUz0X8nygr/+aaVvKaVMur6U7aP9twIgHEiPi+62eDR4xz6AyNFPJDPin3Qfqbd0lrwXk1dAbNpDI654mmW+0jO5Nnbv3p7boGUyMK0L86JLQNktSofzN06QNo9+F7ZxYFbCEjUlD6os5WAwFYFw/TYUZfia1JWInPnc9fEihjfRAaGwJ4iFVBh73/iTZB2QkQAAA==" \ No newline at end of file diff --git a/assets/search.js b/assets/search.js index c63b085f..24d25852 100644 --- a/assets/search.js +++ b/assets/search.js @@ -1 +1 @@ -window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA81d33MbN5L+X6RXRSYa8zNvm/jusle5261LNi8ul4umaJuxRGpJKl4nlf/9BsBgptHTDWBG1NW92JII9NdAN7obHzDDP66Ohy+nq2/f/HH1ebe/u/oWbq7264ft1bdX3a/bf13dXD0d77vfHg53T/fb0yv719tP54f77qPN/fp02nbdr67+vJlKeL/uPnxl/lWriSD74Tv3YVSeDgUiUb+tj7v1+4kwUebN1eP6uN2fqWoJ3auY7tUs3au47tWtKJPXvYphPT0+bo95gLbpIlRuxiAyYTBnviCqPdxKAlm1IaV1WW0fDr/uYsr3TWaNgYplh+IFJ1D4gXmE+Ph0zCx6ll103DDaWYaVyY5AQwwr7ccD4Cw/jqM+ru/yMLuGF0OcMVTf+jLYn1Coj8J+YqP/MsQZo/WtL4adbV7X9pK484Z9WTv/nof7+yI0NurEsqeelT11PHtql8xYmbzukeypM7LnADjPPqnsWTaRGSubOTNWNu/Pm+gYOnlDw9wRdApGED/c7zaf4xM3gLq2i3C5mauKyMxVxZyZQ6K4EXTCRJms7p28CFYqGA1wMyJRHNFgZSF2TS6GmD1M13YRLucXsQU1az01UfWdV3MCWbVj3ry761rvzl8Fxf3HubpPxFH1B4ERyZNBDFKFcew2J07/7s+5en9anz5tT7zWVoz9PKmrUWSUX5WlrgaId+/OXx+3WRDXQ9sYUt8DAaoVFJmm4BFvUacM6Ntez8sNeXQL9/s3apYmt4ynBJOyOdw9U5/bXsQCpabTFehm/3uebr2Iy+u23V9g5gYhF9Hv8q7WK+h/L56lqR+tMKF3u4/b0/mZ+g5C/r9OqFPQ/w7Pm9B+tMKEnj6toRTqdkHfocuiUEfRSyVwFTK667IIndQLkdRlP37RzDUiZCYup/EIV6i20KsiGFGczWJhb0m/tA7TeeVUkUp0WYkqGTtmwYvlbEwD1+lySoiFfEwJ1+miSiyajKHfpVSJbHhlPXynyykR2wPH9Bj6XUoViTKRldDJyDsLPsKixHTw3S6mSCQJCDokc8As+GXzAJefhwXr1He6qBILJwT1vJw6Ivkd08R1uqgSC+cE9byoOotcZeh3aVWWT86L+IxApMdU+f2CCkgnyTK+umRgjx4ux3S4tCGk2wARHVYXhBcIQRm9uSD47Jx2qZSW5rCm+LkUlqAC2liZ/fsmsrNyn7/o1gpBZO6teqWFfepx/WUO2K1rnwGY2B//ejrsZwH3HRYho63x/WHzeUoNm79GmeFKZL4+PO03591h76X0lFHcB6wWrPRuADHp7uPF0jfH7fosS3cfP1P6P/an9YcUhms0D0lBM0B9F9ix798jfCdYMyK6VHiR70/n49PmfDgmAa7DxhEw10lkoXd3GVi7SHGTxnj/9YxYIRHFN1uM89v6/mmbxvHN5uBEQ2Uc6TYVLFEvp5owvPUpz/eux4ZzhgirYvTy+93+c4bJfLPFOOfjNmMe+1aLUT5uz2kQ12gWRjm6xP9s//m0O27vvrdB5m+PNvAMoLv9eXv8sN4MuGzzmUFJWsYzwDJWNj8wNsMFy3zIcOav2Rnun0/r+1EGiuBWivs4MU1WCz5LHLbHDZsfrHT38WLpu9N3u/36+FWU7xssRvhwPDz8gLbtFKD/fLH88yEm3X76LN1/Oh93+49R9V2TZ4wggeEbzENAhfj24ZHfAzgHNZ/Okw3sGvarp/tb7tr5cDg+rM/MyI0M92FcM4MvzOp//vS3/xYkuw8XSjYmj8j2H8+Rjmu17//6ehL3jdzu73NEBrmEhChO7LVrEzlk7FtLGOtTSvNr22Q5AinHWYihzTMQflnlYPwi0xN5KCoLRb7AkUAhWyMWY2jzDIR/3x1P00qFgfENF2Ht9qfH7eb8HVuVB2CkZS5aVrEsAt3iX75RqfLZyxFFiLuF7fG0Q1TAQsVuezmR60FJFROMhSUXnq2nl/IyOj483Z935obA98mVkqErlfYyOrtbHD/tfn++woGoF57hiyhMpb2MzqdLqHq6sIZBMOwEnRIq+ia54S+X0glTVAadM4WSLxQKILMy1PxwOTZahDE4ZRwFN1uEwxNSAUacjErIfxWX/W5O5q5AFcXsynA5ghn43z58ODGUyWSChnbPwPpxu/94Thg8aLeo5jkfUpVo32Kp9EQF2rdYJD1/x7Fcf7JtFsYwtFqIEmz1BIy+zSIEQ0fG5fctFvrrGz8FP68/vk2scdR01nonR36vguOqgRawn70zn+U+ViBc6caSTJPEvhjpJJ5TJlDSx0g8Ss5BGMbJOQ5LIomHYhgp52iMR4JVW6tynD5Tsfyy244Ho6Z0CcF8k0Vw1LnwGSzxre6jy7iWEZTtWUahBY5lMLJtEGLMcCuDMsOrRJyUUxmcGT4V4sxzKQM1y6MIGHlq6RV5lsD7lPv0XX8HP5PQFI+MQ2k5R8ehdvOMEqLl2CUDTTzoCNFyDjwkNEyEvg7N4jNWCPZask4GWO6eR0TM2gAF6H3vWbuhGHxkazQHl93yyrjRze0c3LuZJr5OPLEzB5vfT8nQ8c1VApkGuP/yu0Hi5C7OhUqQtst8fRL07H9HKei5T7NPcY6HBzks9LJMoyzde834oPBDqDYxWw/1g6R9BtjMoDBFnBMUgt5ZzzWm4fvmz8eNBSN22OlglIVLKpo0cuK5yAR2FvGfAk8R/pwO0yccw9OVaGxkNMmLjdI04HshQ8Qhqw1d0gjVIB2WrbzY6Gchz5sJOticVThPnRkrMlOZYIHMU2bGUpGVoensL1/WOyGJ9bJsi4V+QVOX+M6FHvKCL12gEvPeukD1nH17OQqbushM0Jc+05+jQ/xhfkmRZc/xZ+mTs9Tm6iM+u5+lUV5yytDpgq5DHtTXS7Vb+ox+lo55Qfz/eOLCB/Jldjw1cen6/PRpraQAZz7LDW6BnMlorSRB3HQ4VlZc5+mrC0ek7DcXiu8iwLJco1y9hXetie8dIEhdoyVII1DA8vupMX+cRyz9uP243nC3Na0o3CaurlVnHoGFEJbK3p1+xNNAZLtPl8oOz8SJaPvhUskiyWZF53BrRPboFefj2pw+r+8nrjF8kusfX9b33MyOckyDuJqjNnKlh09yXZ03IiRvKOYA2PvqDPc7wgwt5oPR5+PwaKbvTb6OnUnbZhHRAr+CpA8tlgEIrDUCSGTQCQB6JuXYbSoE0e7D+NxT0TmrKZCes6pwh9jZyM+HFJpvdxG83f4juR4QQx1aL8KePGzKPs2AXCJOYlKzYU7gu/Vp+292nlg+wGGgRvMcJNj7vx+k5CNdB51ik4gHIg/19TZjqH2jZw719TY9VIx0HXRKDdUPRB7q98FNTRbeNpk3TGYLlZjNEeR6bJ8anlNe2oDkGBHBju3nwrL8vrETyWJOwvDpTM+hFN37nDVJWz7DjBIHFgGKk198Rwn+8bj9sPvXXAWGXgtVCK81JcISr0KCA0irwBk+GaFoy2eEqbtEiGKhUk8X8F1Tw05Eq7Ddy/s6ih5zPD0atrL9HIHP8/IofDJYc/h5ETtPgWTY5hTIi92iAtjX/rHPW2Bhu2f4Wq87++itCHWNesWGTEaz0Oc4BbJ8ToSfFWDk8Qfw59PdN7vTN7t9t7Hanbd3c9RBDvD94eH9IcsFaMsXdQIWLNcNJmNaaImYEjNtEVOJO418LZ4JosWde1EiaouMbEdw4udqbL9M2jwPPmevn6tAcBsoDz56I2gWeLiFzUPP2NVG4OkmWjr9ZrbT06bzK/mfvu43GQfuDpVp/JyyLuFpElqet3EDW1RsiWpMKq50zJmhVDwIiEotCIRxpYL9uuE+0zQMavViJfAEJKcADvRfNO9T2BwihIedtbWbAmdt6yRoatQ04YRavVhqm4Bkz+4zy4opcNbuUYKms5viuIY2L7tcYrvFdJhAI1luXKTCgkjFqjB/GU02jhdXI8vfJtvHi6iBfY8+xzDVI+s5hqjfvfmv9fHz9vg2E+T6nWv/bu5g/Vhk1vMX8rgt5jz7z+ZWKyHA67/8x7u/f8fKdx89T/xPP/zlHb54gOX3ny1nbIOj74mJ0kffUR+gDzrL8pOPO4/tl0WZESkjfsdgpg9WR7DSj1enAZmniCOIGc8S50GS08IEZOKR4jzIyAYrREvtqghQ7BHgCFLiQeA01ORZ4AhY8ongNNx93lKOP7ibMyr0hHZ0RJHntNMOkc4fI9TC3EFHScJi8Ig1i55+oVY0PL7KlB55y0HYWhqMvXqViPRDmxeN9yEKG/Uz7DaOZ1kuIFosqLHSKuTkCaIHny0uoUxWDiHaCJnkUuok8wujDpNlLqVOLCMwmpwuocS8vES0YLLTJdTIyFlEETZzXUKVRD4jakyy2mVmI5rrJjNBMt4lnDMjDxI1lmZDfjbCvcg/9p/3hy/7IJfg/Qj6/Hmbnp+pH2KUn7NePRrb9vz903p/Ro+HTia1b/CiG2CMwVttaiWveIRVStALzxhSIlBmv4AcNRczOP8W5glQ7K3LPAx7tff7p+PpcGQu+GJKZWiz3O+m94j5wT2TfEnP3ki8ZM4gIVkib4tPAcZfGi9DRt6qnoKMv1w9EzJ4wXoKMfqe9UzAj7FyjeDFXrmeacWc1T0CLqmCOBVyLr+/H7/1OXr7ffK1LJnX37H8xP33JIRwAR5DZH3BawRCuAiPIYYmCyGEF9AjhMRXTKQApOsT9G3d19OGPGL4nmkWjruYyuOFLZ8FSE/QZMCx5RJAynJPcH5Jv1AyIp5w3BPpw+dLhFOGeyJ9bLBEfFCtTmT/mHiPXUJwwBKxwlOv4YsBTJmbKQRuswSEq+knKGGjJTCTin6C8XPGWxEjAJNjrQkAarEEgHwtwOR5yeuhQdYDd1Q8eanjVHzijY4J8ZMvCGD0H5ssgkgF9REpN6rnAMbCOkHMieu5kFJgZyBTkT0BKYX2ESkV2xMAQnAf5Seie0K8FN5H+an4ngBgQ9coPRq0MkQnVk0yxqcg5CCPQNJRPgETC/MjTk6cTwCJgX5ESUb6BIQY6keIZKx3EG9v+p30t38MxxffXsGtvm27xh922/u7ruMbf41mc3h4MN3f9p/9sjUv1DItXJNXq6ubN6ubsrhVRfX27c0b38N+YP9gm6nuN8U1U0Ez6H6Dm6K9XekmaAZBM939pjlpOmhWdL8VnLQiaFZ2v5VcszJo1q3WNxUHWgXN6u63mpNWB82a7reGk9YEzTqjvGk5aW04vWa2FWsHRQxhLaE4kSq0hXkhwxvFWkOF5lBm2pVmW4YWUWbmFWsTFRpFmclXrFlUaBfzRb1vVMW2DE2jjAkUaxwVWkcZK6iGbRkaSBlDKNZEKrQRGEMAayMIbQTGEMDaCMh6sQuGXzGhjcAYAthFA6GNwBgCWBtBaCMwhgDWRhDaCIwhgF09ENoIjCGAtRGENgJjCGBtBKGNwBgCWBtBaCNtDKFXXEsd2kgbQ2g2pOnQRtoYQrM20iSs2bjGB7bQRtoYQnc20reKNAxNpI0ddMmKDE2kjR00ayIdmkgbO+j6RsNtWxRhy9BEuhHVDC2kW1lkaKHCWqi50avbuoUwqocWKqyF2hutb+u6DluGFiqMGYrVjS5vq4ZkitBChRb1LEjusclH3eiik0nQQxMVpSwzNFFh7FCwnlSEJiqMHQo2IhehiQpjiKLgzF6ENipkGxWhjcqVlLXK0ESlEhd7GZqoBHGxl6GJSi0u9jI0UVmIi70kFUIphsQyNFFZiSGxDE1U1mKQL0MTlY0Y5MvQRGUrJvcyNFG1EpN7FdqoUmJyr0IbVSAm9yq0UaXF5F6FNqoKMblXoY2qUkzuFSnkKjG5V6GNqlpM7lVoo6qRas0qNFHVStVmFVqotuUCW0iGBqqVmF/q0EC1sQJfm4b2qbUUt+vQPLWNcmx6qUPz1HKUq0Pz1DbKsYmoJqW2jXI12zI0T23N05m8i/C1DluG9qlbMRfUoYEaY4ai5UbUhBZqjBnKFTOdTWigxpihZIuKJrRQo8UBNaGJGmOHEjjw0EKN3QdpbuRNaKHGmKEsuMzahBZqjBlK1t0bsh9qRP9oQgs1dgWx/tGEFmqNGUrW4dvQQq21EBsS2tBErTURvyULTdQaO1Rsvd+GJmoLcebb0EZtKc58G9qotdvVrv5ob4smdJA2tFFrDFEBq2doo9YYomLr05ZsW40hKraqaOnO1ViiYkOI+wy3NbaoWNO7z3BbY42qc6jmdlUCaUv2rytrKnY77j7DbWVjuc9wW2OTit8crsgudmWsUq+4Fe0+w20tycBv4ldkJ7tqIvqSveyqFZ3GfYbaWl6h5umBCecgBkBFSQdLLdSsjylKO1hyoWa9TFHiwdILfLRWlHqwBEPNuyQlHyzFUPMuSekHJW+cFCUgLM1Q8+5LKQhLNNS8+xISQlmqoW7ZtoSGUJZsaHhWCShZZGzT8BQfoSKUJRwaYF2dkBHKUg4Nzy0ROkJZ0oFNdYrwEcqyDvw2UhFGQlneQTAF4SSUZR6agh8aMZvlHvhgrggvoSz70PB0GGEmlOUfhJVJuAllGYimYvXVlOWzZqv5tsRsloZoeJckFIWyRETT8nKJ3bSc1hShKZQlI4QMQIgKZfkIIfoSrkJZRqJd8XKJ3Swn0fLLgvAVyrISLZuIFWEslOUleHJDEc5COdKC9/WC8rM2TLLlryK8hbLshBBSCXOhLD/RdstY3aqSzC/hLpRlKFo+rBP2QlmOQpoHYjdHYAjzQOxmiQphHgiJoSxVIcwDoTGUJSuEeSBEhrJ0RcunIUJlKEtY8Bm2pMR6xGyEzVBlZLkRPkNZ1oJnvBRhNJTlLfhITSgNVUasRkgNZakLIbEQWkNZ8kJQlxAbytIXQqQm1IayBEZbcUMj3IayDEbL7l8VYTeU5TBaPqBW9EDELjY+oBKGQ1keg7cEoThUFVlrhOVQVcRqhOhQdWStEa5DObKDL6EI26EsqSFYmBAeyvIa3X6DPxsidqtlblcR2kM53oOfNEJ8qDpSlNT0KMtSUys+sxD2Q1mOo9v18I2J6SzNwZI/ijAgyvIcgjUIB6Is1SEMjtAgqolkN0KEKMeE8N5DqBBlGQ9JX2I4y3kIRiZ8iLKshySXGK5xhuN3OIQUUY0zHJ8LCS+iLPvR7Sv5xsR0lgDhzxIUIUeUpUD40wRF6BFlSRChOCIEiWrdouM3T4QjUa2c4QhJoiwV0m2EebnEdpYNETYYhClRlg8RUifhSlTrTMdHbEKXqNaZjt+WEcYELCvC7+iBMCawcsf9bFwDQpmApUUkweQ42dIifI4BQpnASo6XQCgTsLSI4s8wgHAmYHkR3h5AOBOwvIhSbAwEQpqAJUaU4o/LCWsCK3kfB4Q1AXdRQ7ELGghtAv1dDXZBAyFOwF3XUPwZO2FOwN3YUOwKAUKdgLu0oVhPBsKdgLu3wZ+ZACFPwF3dAN47CXsC7vYGsBkPCH0C7gIHsKUgEP4ELEfCpxuglzjAHZxpVjC9x2FJEj43weQmh7tuw1IHQC9zWJZEcHx6ncOyJAp4L6I3OkAuV4De6YAqNhXEelBH/ILe7IAm4hf0coelSpRwuYTwKKCd+fj7JYRIAUuWSAMkTApYtkQwCWFSwLIl5vs02ds4xH66iKlM7KflzR0QLgUsX8LuVIBQKeCufLDFGxAqBSxdIkR7QqWApUv4DRsQKgUsXSKEWUKlgKVLhHIeCJcChVt5bPIFQqaAJUyE0REyBSxhIiwmQqaAuwXCzzAhU8ASJkrzV8kImwKWMZGUIKZzbIqgBDFdIR+UAmFTwDImir8tBYROgVLeKAChU6CMLDpCp0DpbinyBQDhU6CMmI4QKlBGTEcIFXvnW5o1QqhAKVebQAgVsKwJzysBYVTA3RLRmlv4hFEBy5rw3DcQRgX6myJ8BiOUCrjLIrrkGxPTOU6F3VQAIVXAEieSxsRyVcRyhFQBS5zwzD4QUgUsc8Kz6kBYFbDMCc+qA2FVoIpUmoRVAcuc8NQdEFYFLHPCM+VAWBWo5Q0eEFYFLHHCM/tASBWwxInglYRUAUucKM1PMGFVwDIn/NEJEFYFHKuieWsQVgVq+YgOCKkCtcyHAWFVwDIngqcRVgUscyJ4GmFVwDIngqcRVgUscyJ4GmFVwDIngqcRVgUscyJ4GmFVwDIngqcRVgUscSJ4GiFVwJEqvKcRTgUcp6LZizZAOBWwvIkwOMKpQOuCJV90EFIFWpA1JqQKtPLNICCcCjhOhbcyIVWgla8HAeFUwPImquALFEKqQOt2BnytRlgVaOXbDEBIFbC8CX/5CAinolfyVSFNOBW9ki8LaUKp6JV8XUgTSkWv5DWnCaWiI7dQNKFUtGVNeKpGE0ZFO0aFLW81YVR0z6iwVI0mjIp211CEwZHL4JY0YTcmmvAp2vEp/D5fEz5FOz6F32JrwqdodxGFXcya0Cm6fwBGEExM5+gUvvLRhE7RljHhY6AmbIp2bAqfFTVhU7SKZDpN2BTt2BQ+CmrCpmjLmPBRUBM2RVvChC9bNSFTtCVM+MtUmpAp2vIl/HG+JlyKtnwJf5lKEy5FW7qE90zCpGjLlkieSagU3VMpvAMRKkVH7qNowqRox6QInkmYFO2YFMEz6ZMyliwRPJM+K+OIFMEz6eMyGiKeOXliRkc8kz40Y8kSwTPpczOWLBE8sydS7KOUv22P5+3dX90jlW/eXF3d/HH1rn/Csis6rTTzrKW5pfPtH3/eXJmas/vhz/HZSvObke+/E3sU0E3CIEDXrr9u3f+F7v8v+//7v9f9710lY/83N8vcD10l735oVv6Hwv8g6bQ+vXev2BqVGt/u9MdV04r97GuWxl41oLlQXgGtpP5f1rsz7m+OOkcBdS30M0+fm7A/dkS40M/QKta5wp2LsXM/VVUT7fz0+Giee0ezNUroDVNJc2YkQDBnY9/ehjXE+pbV9uHw6w6LaEcRvX+UsdHrAF/hKe+dp4xpr+FT1w9LwCvAj1+nJDyuA9dRNbZ8L6TMEDIxhmqQpH59VJLrD5KmYtAKUFUvpoiKoUPSODL0EqS1MEiYKoL8U3kHjbmIhqkMvDD7FVLFfeT3oD9yMdX7WBVbnjpYYYB8DLyPxbtPhgB4jfdDKGPrtGzenzeBBDSR0E9kGXOxsvlwv9t8DtVAzg69s5cx7zJ0FOqO3Bx6Ny9jPlEVxKsAuTf07l3G3KEqzNsEsARkTPABI7ZerQSihl6hrNVH+jK2PJqgNzKm9hE7Ng0b96UiOGzheVAxZP99E7gzNoOKjX34rkPcu8K9Y3Pvv3EDd8YOpGJjHr7nEffGPqxiK/gUpDic42KLxr4OjSRXnCDSXYOFjyJgbJJd1yAtoSmOra6+J5MUkXukB0xSIvLt+By/YmId6gzpzmWwLgBNGKRnjMQW7JbpSQsXJDKyWK+5vru77m+789egOzZ0RG/z+jzcDa0FLUZiWpsWyLR1HwGbPr8a9isiZhpGcCQCOQrazvZVqb/Z16/g9IwN3orzbiRwwQTPPMh1m+nOBQQch82xYKT7RHMVuKryMygm5q/n7X3/snK0znDhpr0Zqt4uhnOWpR36N7Ejabjq8pkBqtpLE13TvbgRleQo4jV9+db2+Vr5rKcqj7Dq/2IOmXtM/5fRtfqawfB0/Q9iZOnUodPd4nKw6FVSpdeg7GdMQ6+BFlcE2XWVSHDTD9Hrap5W63/wFln5Ea48tJ8XQ672A5PyKU1nGq1FP3UK/OD89lX5fasqh5n3P9S+ceMd0G+Cwe96ofC6l75N6T+q/A+1tGeZrPkabxBUtFuYRFG0qmMTtDm9+vVkXlyGjI8L8ELy4r7zcR06TrABkFbn5rA9bgLbVAhTXNQb/8WwXGwKak0xrm8O+9P5+GTeGRW4JYIfOAhfMivv7krcRmyO2/U5GFCJ4pX3FuX3rKr0GK1oGyvx3r50LMz3OOqIGcR1f9qf1h9CtVAEF8Od6/xbUFjVOCKIdWTfUwU9sUuI9evd+uO7x/dhusD1Y9VPnfa7Uw1SQJvW0AXaRQxck9+fqmKw82Ae/5fWL+9Vv/IBfIQdAr72q3oMj5KbOM0+7I6nIJHUmJRQUiRlnR5nRTXoGJ+Z4ymUgfcXAymoJcf0705Gs4t8qvCTWnqSzxtO1eB/GEg+P3M+8JvrWH0UHdKWVCY4PdwXDKOcjMthkGLX9uExrAkrHGZXko9Od0i4nir83tBni3EuvMvVA8/pvcgzDOCzDogbdHaLhbfHns8CkPzPiTgfQhm4qlxFu+72H6dFlcLcEYhlhv+6FDTpyG9an1l9cWMenuxnz7u1nz1oJN/0r39FGJgMWpU+dEiOYd6/GqQz7BcixWd6EZ6xQrGrldK26UeTb413sCtPsYv7KyPi1L/JEaHjHLGSBvsxLGdLTM2CX35SpPdvaUdzhae68kYb609p9qykcKuF1NfScnDdXk3DURtQvNLE9d2ZYeA9gkii9t25/aV5rAnRw9J66CWcPq1V2Bsn2kZajmNvwgbgwYuHIey2GHms9ruHPhzXvjYWC1cnBIlDgVHaJ+72p8ft5jzZDtXYe5Vk/93p/W6/PoZhHM1dK0387uS+qQjPGrZ5KzkqXaoFPg6RDOUquAmiDrhVv8z9YYLW0rKjglqc7/xJnGqHzajPMz75gt9fap8ttJbsY7DomBVem+CP9rQvPbTIx/RfAILCDZqB1m8jV5IuD/a7eUJNcNrxezXwxQX440Zopbl88G+HDsuhgP+XzDr0nbI0AesOUgAZBLBlHa58/QGC9rsHLRJmg1CuVggOJfxhk/Ynnxokt0dfiofqLFzUe2ofhqjfiHb0wmglVePsIXKRQ3cm7AdnYEOV7h3T1xU6bhEje5oTzMV9FNK9cHFvPIialKc4u4PkmLYFDs1obgpfTvtyU3nCQXkeS/llqRq/6v05GMBAU/h1Uvgtjngi8rg+hmukwSnKn04pkU589F/1hRdvcK4jzePjsdsshee3Aevs6SfwLA6I8YfwFAXyFvH+w7GrWXfH7Z3b1R4ez7vDPqxgkVuIW/Fphsdrp5HSlEntZXj2jxbwwMm10lLp+pcqKA4KNHXe6kqc+67/O6KAwhw4VENc8tUCSNXBZBkER7y+uKiGvaco5+t+E1umwWlhIS2v84EW67hoElPQ+TCp1YOzF28RXzRpcX2fD0zJjksQz3aqgV70V2Vg2DMPOdOvbS1u2T3eeR1AtjgYFfKwQyKowVuiCGRIAjU4vA+MyRBJxTr3fFybl8Kv78MVhHUQCz33DWCo4kC9Wp9Lxd3R015Oz7gGEp3+yb3If1r6BYfi3nhDQhapy/5b29B4kNs23lHEzab/Qiq8ccelzrA5FimA4buC0QrAXuuHoPxlARhWdOWzjT8D0/5mhxbJii/re1KlBxc72HG+vbl63D1uuznvWr15++ef/wuXVeoNH/UAAA=="; \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA81dbZMbN47+L5qvylgE+9XfNsndZa+yt1uVbL5MuVzyjGwrnpFmJU2yTir//Ypks0WgAb605Nx92Z1YJB6QAAHwIbv798Vh/+tx8fru98Wn7e5h8RqWi936abN4vdjuHjb/XiwXL4fHxevF0/7h5XFzfGX/9fbj6elxsVzcP66Px81x8Xqx+GM5lfBufdwcX5n/VauJIPvjW/djVJ7GAgNRv6wP2/W7iTBR5nLxvD5sdieqWkL3JqZ7U6R7E9e9uRVl8ro3MayX5+fNIQ/QNp2Fys0YRCYMSuYLotrDrSSQVRtSWtfN5mn/8zam/NCkaAxULDsULziBwg/MI8THp2Nm0UV20XHDaGcZViY7Ag0xrLQfj4BFfhxHfV4/5GE+rx+uhlgwVN/6Otgfg1Afhf3IRv95iAWj9a2vhp1tXtf2mrhlw76unX/Lw/1tFhobdWLZUxdlTx3PntolM1Ymr3ske+qM7DkCltknlT3rLjJjdVcyY3X37nQfHUPd3Y4Nc0dQdzHE94/b+0/xiRtBXdtZuNzMNVVk5pqqZOYCUdwImupWlMnq3lQxrFQwGuEKIlEc0WBlIb4cHq+GmD1M13YWLucXsQVVtJ66qPrOqzmBrNoxb94+bHan7emzoLj/OVf3iTiq/igwInkyiFFqZBy70+bwfn2/kQbif4/vKOtmlPv1+rj5j939/iEIzqOUqdigedaQRn0D9FXVoWE5eXPQb1D3LEVCGZEp+XZTNCVD86tNiZM3B/0Gdc+fEj9geUq+2T9s7nNVso3nTodaQTVCb8qc8wx8c+6ZPw1ukIIqD2VOEahy7jlfFVj1rarPEeFvL4+nrek46nP6/MyoMrab7Z2BI4zCCmIG7XMVt7D/Nxf8ZuidZ4zJmAWVng+b99t/z1dq7H+xWiiebLLDK6/Wpiy+xtTiHKkg0tI+Vwm3D9mhloW/eSiLtZNxJ6YnO+riHv83ayyIePNWWDT8zlhfgUJzV1dUpYLkxOlUmqHylCpIU5xSpblKVCr053/uShc77nEVfx5GdpwJfxP0z5saMuqL/ZpTqtCvRZVmBkV5npBKp+PDV9vjV9vdx81he9o8zFMxcKhv9k/v9oUuRfv86U7FKlDuVpOxX2zFmGKz7RhTM9ztbO+P3HZ2e38s4RKO/GbcSLE/J41t1DhLb+pan73t7VtTW+cg3IxNY0Cug+RS75LHXCzmLemXVuB2UDaih0TcyRrYHlfCFhmuGLzrdCUNRGIvpoHrdD0NZk3D2O8qekSob1kJ3+lKGsSo8JgSY7+r6CEdm8ga2B5Xwo4co8QU8N2uo4VwXB1RAK6HPW8G4MozMGNJ+k7X02DmVAQ9r6SLeNwdU8N1up4GM2cj6Hk9XWa5x9jvqnrMn5br+4lwXB7T47droUuXxWRwdbW4Hb08FlPgqvMvXfWLKLC6FrZw1CdDd9dCLk5WV8lV8SNCHjzoMwc/2BB9XB8/xnZE7vcvuiUKIDL3RIPSsyd0ipg9o0PXyZReOuTz+a/7769UkSa3zJEwmhS0v5+lz22KvZaVSqwAxB7P0y1FIs/WjZyJzNMufTBSot/1XW1Q0P93clse1dSPVmLBth82x9OF+o5C/r9OqFPQ/3cyT8QndBitMKHHj2uoIxULo+/YZVaoo+i1iiROHt11mYUe5C7jZveR3OV+/6K5K4DIzF2D0sJ0Hta/loDduvYZgAkz/nzc74qAhw6zkAM69nF//2lK6Zp/jTK6jRig37/s7k/b/c5LGSJb3AesFqx0QoxT6e7n2dLvD5v1afPP3XH9XsYIG12IlMAok67gfH7wNbLj0H+Q/bVgzYjoWoWLfHc8HV7uT/tDEuAGN46AuU5isbR9yMDaRjbgaYx3n09B3S2i+GazcX5ZP75s0ji+2Wyc9THPCW7ODUuw0HHV43b3KWPufLPZOKfDJmPqhlazUT5sTmkQ16gIA0fZ2I1Q8/ucG6GfT5uftptzxgrPDYlM3zYjEKRPUu/+tj582hzeFAPfvHU93+YfVWKNRnHClPzj43p32j/lKDY0/dMnJMTl5yM2fj9AwSNQCIhZJTMppIeO42gWZE5QfUU65qSKPPBk3ohA05ud9vdvXg7H/QEtxOF+J6fEufXc6Z8YPDsG+MZXMXzJzJ8DQPHsk8Ueya35SmQk24QakXSYr0ZGfixRA2XLfC3S6bNEiTCZ5uuQzK4lXlEWkc5KTKNSUWLiZkbQaUz85l9zN1qn/XfB2V2wg7BC7K+JdW11YGW/P+yfYtKH32fL3/zrZf14FMW7n2dLv99vDvfs5spKdz/Plr49fr3drQ+fRfm+wUWz/8PpsN19iBrANZmNctonMHyDMoSAD9o8PfOsvzOy+bVMNrDJxq+e+y33oBw/w/vD0/rEjNzIcD/GNTP4wqz+9w9//x9BsvtxpmRj8ohs/3OJ9JAy+Oav3052PUbuN3/9tkQkfoABL3NO7I1rE6Fkh9YSxvqY0vzGNpmPQLgaFmJscwHCT6scjJ/kg908FJWFIh93JVAIQ8diJJ68yEL4z+3hON2nMzC+4Sys7e74vLk/fc2SQwiMtMxFi9LbSaDb8D++UrcJytvLEUWIhfXmcNwGjPRMxW4HOZHD1KSKCeL8Hj11M1dPL+XL6Phknrsw5ynfJFdKhq5U2pfR2Z15/bD97XKFkagvPMNXUZhK+zI6H6+h6vHKGqJg+Lw+HBMq+ia54S/3ZAGnqIxThSmUfP1CACnKUOXh8txoFsbolHGUsNksHP5cBGHE6buE/Fdx2TITymTuBlRVFVeG8xHMwP/+/v2ROTCYTNDY7gKs7ze7D6eEwVG7WTXPaZ+qRIcWc6UnKtChxSzp+TuO+fqTbbMwhrHVTBS01RMwhjazEAzZGJc/tJi1qu/8BPy4/vAmscKDpkWrndw7iRyouQZzTtQMiRd5YcJEcNghsW2mSudcxiuCjj/JTfFR/6y0WaZMPJ9mKpP5eoQMdRJXALMVos4SeaiV1yrridZcZymbEPTI6IzpmP0Qa4Y6KYogVyFqH/GtDLxOGa9k+DILOfZChtgxBD8x0bcOlFkpUKzoGeM8xS5a4JP3M3xJ5Uq9e/KehmsrR9Phz+EVQpIJzW8XX+gLZeVc6wv1KrvcFyLlXPHjkYKTCeGGe4hjmlyIItxUD1HmjmVi7fCiKjH2Yc0d8M+ytRFVYGqj1CxLG5wCQ2OcbDsblGwzixhxKxuMmeOgDwW9Ilf1vZndr2+HK+6ZlhYvoGJpORdRsXZl9sZoOSbPQBNPlzFazimzhBaenH2LzeI3ORjsW8k6GWC5JJmImMWYIfShdxF9FoOPlHIluCxHKuNG2dAS3IdCE98kHogpweYJOBk6zsYlkCcxx/7fQYo57tfsU/dDcBNzsioHWaZR1jIZNOPX5HdYbTJrA9R3kvYZYIVrcopYsiZR76z9RRo+Sg6U4MZiATvsdCzIwiW1Sho5seVPYGcd1KbAUwe0nA7T5/fwPiQamhhN8kKTNA2TACG+oHnQ4IpvaKYS817RTPUsfrQsCpt6yoygz30uOEeH+APBkiLzngXO0icnxJTqIz7/m6VRXgjI0OmKrkMe9tVztZv7nG+WjnlB40+eOPxQr3xmlJq4ScE9DXLi0YJXtPho4W/+YJZsHwIiaSKb9MmLe3M54yz0rHQuisj01WKlMr21VC20+yhWKmczUqySeLc9T6esvUKOUqxnkyI8S7uCmpx9FiZSGpXiz3ejgkK9WKmspFqqUnkMKC3pc1QKneiHz7v7OY7E9PvTnUnSodihuEm41KlE5YqOmS5RNdvZRFWLjk8KVZ3k/uPHtZLSvvktd2OD5EwqHStJEDcdjJUV13n6jcMzUvYnDsV3mYSyXKNcvYWPsonvLSFItUp8S5FHCj/mKpVymTUcf4PGCzH/WMbBf7/5sL7nniayosI28YFbdcq4/gBhruzt8ftwGohs9+tc2fi+KRFtf5wrWTyPsKJzjiGIbOwVkf2C+Tl3t0AeLv6J3Cp1DxUTgUOjtPJCxsOQ3/7lv97+4+s4omtzJcAfvvvL2zDisIhDo7mQQZWBfDdIRQQwz4nTWy16LzgDMXlNGCPbjqWJV8SOFnYFwNO7yjno6avLBSowV3VzdMi4uVuoBLnDm6tE4kpvoRLsljGKL+8S49Cx27k52InLugXgk4u7OfDJe7wFCjwWBpv4BdyikQdXrvNGHbmBXeBqsdegiODFr4RJzAQJ9+hedVyf9OO0eWH/VSle5KkHZrB2RMKAbd2Ym+XGxn9yrsO4bMYrsf95zBfmQaJX0a6zWKmiHEk04zPlVdUry59EPyGLXl3B/NzKKMhk2KsrmJX7GN3yX0OSo9bMnEz0YjLzVRUryddENTZrX1W53FxOFJtk9CvPWF6en8wWyfZXdfuSGoAodnElwM8Y3nH+c/dpt/91h3Iku+sMGl5ps/sj9XAW98es17DIoGf3OKxNal0/TkiJ8Zdc5urX9SPH+ZzlmAZxhc/anBEq1Vd6dYYJn988s3QPw4uHbmLPbtpmEdHCvbZA+thiHoBwWTcASJwGTADOpdX6sN1Jot2P8bmnonOYMSQ9hyELO8Rum/+4T6H5dlfB2+4+kDIhhjq2noVNfYJ/61fgEvGddsrluC/CMyC42Xwo+qibAHVuNh8KP7UlAPlG82CmH+VmYMJGF8JkGIppeyFohsmYtheCJo03aTkPUPhSLQM4aTkPUPySKZerpm0vmFbm3pA0r6jphZDfJZPmtOk8yNjxPwPLN58Zb7hnvrmQg9tdAJYTSHG7C8DSoTRsNROIvoiagzm3mQdCj8MYjJ8SZycpCHL8xSCMLWa6OTnu4lx7bDIPAm1sGPnfx0jmHOGIUBUAoi+qSIJMSUwOJmw1N4FMt4Js9gibzYOabP0YnB9TZw8pEPrycwbj3OSCkJKMJhdGrOn7tMWwFTa9ADIL7CIYbmsbfDo7uredfCMnc3Mbyk/sbpMQwvY2hMj6KFQEQtjmhhBjk5kQwmuYA4TEq+lTAKlqzb+zNrtWw29bLd5dYLycvUUmoFTDTAFTVUwcUMr6I04q58fFCxl/lJ7I93HhUrYfpadyfVw8m7dG2dF0lRbMZnkkPPUyqnkZ/gyRzu9xkFh2H1FycnscRszsI0Yyr8cBxOJ6BEiW1nMBuNdoZaDJL8gpY7AwbBYvkgcpb8AmkOk9WB6ktA2bAKZ2Ymm4GLOF4HLYrQK4TEMWsFwF4JkmLWC7CsCzjJvNeqWBk8wXAs5mv9LAGQwYgi5gwTKnO8qETec7iw0rgBapKR46SU2lofOYMQRfxo5lxK84Q4ZDWB5LlgmaG6jz2LJM0LxQncOaZQDKzFlZ0s0Bkxk0hJVm0dJQIpOGkJJsWsbyEBk1vCSSrFoaSuCJEE6CJMoDERi2CVCCZcsAizFtGC6HbctJXDHGjWStHNYtDRlh3hBeBvuWBpMZOISVZuEyQ1VWlLpCRIwxckxYzGHlMqGzQS+GI98ImjzgdTM2yHpCiIonb3ieik+83jkhfvK1IEb/c5NZEKn664yUW3rlAMZ2FgQxZ1ORCylVHgxkqvBIQEpZ+YyUSsgJACEXn+Un0nBCvJSBz/JTyTcBwGaLs/RohsgQnVg1yUSbgpBzbACSTq8JmFhmPePkJNUEkJhPzyjJVJqAEIviM0SyHr5CLKPEV0lUy2K/suIbq0VupCtTIxbzRDVyol8eFxizejEJSWHfLIcjute/j4+qvF7Arb7tF8vF++3m8eG4eH3nlFku7vdPT0bQm+G3nzbmvX2mhWvyarVY3q2WdX3brvo3b5Z3vof9wf6DbaYWyzvFNVOoGSyWd7CsV7fNSqFmgJrpxfJOc9I0alYtlncVJ61CzerF8q7mmtWoWbNY3jUcaIOatYvlXctJa1GzbrG86zhpHWrWL5Z3PSetx9NrZluxdlDEENYSihOpsC3MWwnuFGsNhc2hzLQrzbbEFlFm5hVrE4WNoszkK9YsCttFmflXDdsSm0YZEyjWOApbRxkrqI5tiQ2kjCEUayKFbQTGEMDaCLCNwBgCWBsBWS92wfArBtsIjCGAXTSAbQTGEMDaCLCNwBgCWBsBthEYQwC7egDbCIwhgLURYBuBMQSwNgJsIzCGANZGgG2kjSH0imupsY20MYRmQ5rGNtLGEJq1kSZhzcY1PrBhG2ljCF0tq+q2BY1bYhtpYwhdszKxjbQxhG6WVXsLusEtsY20MYRuWZnYRtoYQnesTGwjbQyhe1YmtlFlDFGtOJkVtlFlDFGx66jCNqqMISrWRhW2UWUMUWkWnWQfm36qZaVuV1WNW2IbVcYQVb3U9a2ucENsosrYoWJNVGETVcYOVbvU7S3UZEDYRJWxQ9WxamITVcYOVb/U1W29IujYRLWxQ82aqMYmqpU09BpbqAZx6DW2UK1Fq9fYQnUlWr0mJYKtERSLjk1ktnd3NS8Tm6hu5RFhE9WdOPE1NlFt7FCz3lljEzUrUc8Gm6hRInqDbdQYQ9QVWyNhGzXGEDUblRpso8YYom4YB2mwiZpaKpUaUsc1YoZpsIWaVswwDbZQ04kZpsEWanoxwzTYQu1KzMMttlCrxDzcYgu1IFYWLbZQq8XKosUWaiuxomyxidparChbbKO2ESvKlpTbrVhRtthGbSdWlC22UduLFWWLbdStxIqywzbqlFhRdthGHYgVZYdt1Glpg9NhE3WVtMXpsIW6WtqAddhAXSMWNR02UCduiDqyI+rEmqbD9ulslGPrjw7bp19J0aPH5umVCN5j8/QgisTW6W2M65YabnWNE2uPzdNXUhLssXn6WszqPbZP34haYvP0xgh1v9TNLRAlsXn6TpRItqzGBA0b4Xq6azVGaPjN6IrsW1fGDA3wW1yyc12JNnI/hU2NKRq25na/hW2NNRo2v7nfwrbGHk29rOC2VQ1pSzawq0Y0q/stbNuK2dj9FrY1hmnYXZf7LWxrrdZyC8D9FrS1lIIwtgndYM3WsXIp4WBphaZf6v62UcRulHKwxEK74kxMOQfLLLQC5UHMZrmFlvcyyjtYdqHlaQ/KPFh+oeWJD8o9WIah5akPyj5YjqHlTUz4B2VZhrZlp5cwEMryDC1vNqA8kTFN23NFpyIshLJcgySX2M2yDYKbESZCWb6BdwdCRShLOAheRsgIZSmHjt3IKEJHKEs6dOweQRFCQlnaQdKBmM0SD4L7ElJCWepBcElCSyhLPgguqSnBp2WXJNSEsgQEbwrCTSgtW42QE8pSEB2/MAk9oSwJ0fExnRAUytIQHbtLV4SiUJaI6NhdiyIkhbJURMcvTEJTKEtGdGw9owhRoSwd0XVsriBUhbKERMdyKqqixGwleyShK5RlJXo2wyvCWCjLS/T8qiCchbLMRM8zzoS1UJabkPQldrPshGBjwlwoy0/0/Aoi3IWyFIWQMwl9oSxJ0fO1AyEwlKUpet7PCIWhHIfB1wM1pdSt3XifJDSGsmRFz/skITKUpSv4coswGcryFT3vvoTLUJax6Hn3JWyGatwBCH8CQggNZWkLteLPowinoSxzoVZ85CG0hrLkhVqxBIwizIayBIZa8RGYsBvKkhhCHdXQA5FG3HkoQnEoS2QIBiEkh7JUhlrV/OiI9Sybwcd2QnSo1hmPP8IhXIeyjIawQAnboVpnu5ZVmBAeqnW2Y8lqRTgP5UiPFe+chPZQjvdQfBlBmA9l+Q0hWLX0PKuVkwFhP5TlOIRATPgP5QgQpXjBxHqOA1H8AiEsiHI0iOJzMyFClGNCVMXqTLgQ5cgQbhOtCBuiHB3Crw9CiKhO3nIrwokoy3woxa8PQosoy35IStDTSJkAVoQbUZ2zHcsrK0KPKMuC8JNGCBJlaRBBX0KRKMuECJNGWBJluRBhbIQnUb2jGvmsRLgSFSFLFGFLlCVFJCWI4SwvIswZsZvjTIQ5o+fIzm7snQBFiBOw5Ag/NiDECaxk/h4IcQKWHWHHBoQ4gZVMbwEhTmDl7MZGSyDMCTjmhK2qgDAnsJLtBoQ5AcuO8IEVCHMClh1hWTEgxAk44oRNzECIE7DkiDBnhDgBd1GDLyWAMCdg2RFeX0KcgEycACFOwN3WEK4sEOYE3IUNYIsqINQJuDsbAPzgiOEsPyLMMOFOwPIjvAMT6gQsPSIZgxgOIuuNXt6w9AhbDcPk9oZsNnp9w5IjSrjAQW9wgHw9AOgdDkuPCOoSq4FcVwK9xgFilAR6j8OSI9LkEqNZckTQltjMciP85BLaBLRsMsKagHa3otiNHBDaBLQzWs3GHMKbgJarEiDECVh2RBgbMZolR6Q4QpgTsOwIHxwIcQKWHFHA1hlAmBOw7IigLzFbJZYkQHgTqOSSBAhvApWzG7sVAEKcgCVHeHUJbwKVeHYDhDYBS41I6hKrVS5AstUAEN4ELDeigE+vhDgBS44ozQd1wpxAJZ/lAGFOoJYPc4AwJ2DZEcVfnwJCnUAN8m4ECHcCtbuLyO5GgJAnYAkSodQg5AlYgkTxt7OAsCf2kr+0tQdCn0AtH+kA4U+gdtbjww8hUMARKOz2EAiBAo5A0SzbDoRAAUegmLtiXGNiviZmPkKggOVIBJUJfwJNJGAS+gQsRSJQF0D4E2gamTYAQqCAJUkE2gAIgwKWJOHjK+FPoJFJSyAECliOhOcBgPAn0KqIOQiBAo5A4ZkLIAQKtPLZDhD+BBx/olvWgwh/Ao4/4fkhIPwJDFdHOl4yvWwqs19ACBRo5c0cEAIFHIEiuBshUMARKIK7EQIFHIEiuBshUMByJLy7EfoELEciuBvhT8ByJIK7Ef4EujriboRAgYFA4d2NECjgLpbw7kYIFOhc2OxZpyAMCliSRBoesZ1lSVTFZ1NCoYClSVTFZz3CoUAvH4YD4VCg15HtFCFRwPIkfHFDKBSwNInib0gC4VAgwqEA4VCgd7e2+GRKWBSwTImq+JxHaBToRdoZCImiLVEiXHgmJIq2RIlwkZmQKNqRKKwTa8Ki6JV8nVgTFkWv5AvFmpAo2hIl/K1eTUgUbYkS/rauJiSKtkQJfxFWExJFOxJFGBu5/W2ZEmGnpAmNot3TLvzWQxMeRTsehS/8NeFRtIowzpowKdo99sLTvZpwKdpxKTwtqwmXot0tFPamhiZUirZsCZ/CNGFStHsAhi/yNKFStHsGhi/yNCFTtIqcGGjCpmhYyclfEzpFg5LzuSaEirasiRDnNaFUtGVN+DivCaOiLWvC33HRhFHRIF/90oRS0ZY24S+YaEKpaHcZhV97hFPRIB+Pa8KpaOjl7KHpAzIyq6LpEzJaydlD04dktFiq6MlTMhFWRdMHZXQkaNJHZXQkaNKHZXRk2dHHZXRs2dEnZnRs2dGHZnRs2RFmRVexZUe4FV3Flh0hV3QVW3aEXNFVZNkRdkVbCkUIhIRe0VUkaBJ6RVeRZ50Iu6ItgSKkfkKuaPcwDb+cCbei3eM0fHok3Iq2/IngxYRb0e6RGt6LCbWiLXsipH7CrGhLngipnxAr2pInQuonxIp2xIqwnAmxoh2xIqR+Qqzouo2kfsKsaMesCKmfMCu67iOpn1Ar2lErQuon1Iq27IngxYRZ0ZY8EWIQIVa0u5kixCDCrGh3M0WIQYRa0U1kh6cJtaIdtSLEIEKtaEetCDGIUCu6iWzxNCFXdCNv8TQhV7QlUITUT8gVbfkTIfUTbkVb+kRI/YRa0ZY+EVI/oVa0ZU/423maMCvakif8pRBNiBVtuRP+dp4mvIp2T+UIa5oQK9qSJ0JwI8SKttyJENwIr6ItdSIsD0KraEerCMuD0Cra3UsRlgchVnSnI8uDMCu6i9BimlAr2lErwvIg1Ip21IqwPAi1ojv5XpEm1Iq27IkQsAizorvYLo9QK7qP5DzCrOg+kvMIsaIteSIoPBAr9iUZv2wOp83DX93LMu7uFovl74u3w7szDBlpxZnXaJgraq9//2O5MFzk69//+OP82gzzXwbg7VvzibtQQh0IaCrXvx/k9DD8fzP8f+f+3zy84v6o2wERlP+j9n/0wx9aCcqsj+/c69DO2rQQDEdJo1gfzQuUg269DrrVg/bmFh7f37wmxWzPzwIC2GFonQRuOzdh5+rceZjATkc7vzw/mxe0BEY4Sximr6siEgBN2bnvYIyujfWtm83T/uctmr6ziMFoTWz0GuErFZrMdW9j2mv4uPk3klCH1hskdCkJz2vkAqoNF8IwEasMIRNjqC6QNHh8F3MlK2kqJlyZwwJq+6gYOqTQq/UgoUlJmCoS+KcaHLSNuYiGqYxwXQ4rRAwyTsZvqH/gYmrwsQ5i/dEKg8DHfKRp490nQ4BwjfshxNZp3b073SMJwUSCn8iYi9Xd+8ft/SesRuDsPlZGA5Upc4PugZvD4OZNzCeaingVBO4Ng3s3MXdoKvP6p1BCYEwf5ZvYerUSiBp6dRaih4jdxJZHh3oHxtQ+Ysem4d69GTgI2gF+NeBrn9fMHlmW5T/RGagTzIiODeLBv5wr6BvYQ3deEeUViVnGfZcTCQvcQ6e7YkWCgKUbr4ifmio2u0eUzAIPb2ILzH7ohSTiMJmku6IgEUTLNCpKYWEJlO7JJNDAhDHHcQJI+gz8UMWCydAZx8WgM6Q712gNQTBhkJ4xEoeCOYP0pOHFGxhZLA5d3+3DZnfanj6j7qGh43qf3zcX9g/8U0dymPmwUOjWQfRvxNxDC9omrG1WQ7xXypeoPo1onwq0nAuMaH5EbVhqKDH+GAGTOKhQndIN4Vz7QsHwQjFx9s3Cv9gX/wXLIfRpn6U0+JgiZ24jkgmRClWInZfjayJDdEUEMqFOoZqo81HfVzaGZosInAw3DFo+pepx3HKR8fm0eRw+hRwGhLD+bIcxQuN3WnIp+vm02b9/f9ycsDhUGIMX13hxon3dh7cCLwut6udeecc1z9QOf/h/afwO0DcG7QfRdB7eK9R7z9Oid3w+bejUt+HgwOcqv4kw1Pzwh/+XxifWztupl/DIHrMJS1jvKco7tfKFkPKYqvJj9NtoDZJb0TReBy7Q+5n2JlOdR+iG6TTPvQx/eMyVn3IfasCX3eBVBm8xc0d1+MNv3j0TAOI+bBJI+nB+xBXpvkWE5jXcWqwk5558wwit5nCjJK6PQcTPR/Pm5rB36EO9tHMdeh/Wv+LO4WLt5VFvDljnLoxoYsl47z/XwgTFOhh07RfPynt1LY9jdzwdXszbU5EVwnH4bbxqvD+sxqUsFZX3h836hIbYhPPqBZjnkQeRXrasqhX5aF/FjPfF4VaulsKr6/6yO67fY73ChLcS/dv2/gUVp32YNWoxbrieCvVEFIek8cP6w9vnd3io4XaxGQOczy0+oOrG50LR/ae7lipYsdVgn9rvCL0LrHyMqceo41nAMTJ5fhBWo3H9v4wEYS8ViU6v99vDEeWtPrRSLZVpzLqoAueohsgrutjQHxd6gYB6GIdYBflvbAbdQzbNj96vS/CJAzwFAX7zCz5vgvaLrfJBvPd5TMf1OG5/w5FxFZYmjeQam6dnXGJ3YSyvJHedbj+rYMlXw9h7Xw6sxvzl/8UnRtWPccZPBox/SAuUKeuqYLQ+p4mLzfU/7TFVFu6JeinW2a7b3QemeKtCjqgXdf/Xy/oROV0XhhZPAyi/KlU7rrCxgvJOInLN/vMYwZoKK7ixJBLJWvN9CkwCIhpOWpOmG2F4O8RkStNqOtLs3IfVQTWW1FIwMSKOw7vuA/gwE1XSKviAC+c2DNmeB1bihtN/zzecrjBNeQoYfNTUIGV9KwqHpGAAXbzbq2lEUiH7ah5zjfbnBhLSDCrRn9uyK8Q1iGSDl8AWeYh9FTcJg4jjx7XCvUPWU+Syzr0xRxOSlSBygyxZEWjt622fQPvxzEyaUickEBfoIWWC7e74vLk/TbZvfbgIamkG+LkPGRuopQW0Pb7b7tYHnEnCNF6JOh/t5yEQZOgxYv6n4aIJw6jo6a6knEKGPuIjroaRivV/+K24Fs8IJ6LRIVnrQ3c97sb9H613CZ8jtRr3xf4PX5RrMfKTby2gMYarSKQ5jIDJPkmjo4eRuBoJYv+H36dq8QzTiMfUQpgffKRUIjf4tD58wiGqDbcv3mIKfP00siji0ejT+dOrQT0RqOVrMe131rqSAvEoa7JHroP1W4+HDn6+xB3FKJArd4ORV+PxgXcRX1Nqv+3S3vl0L86uR+MqrPCs27vAaqxO/R/j2NqRZZGW/pP/iAuuW8PkO5JF43ZUPEcdpdHK1LySKZCY1IbJoujkTo/uMK7PkY0cC6sxTiTV5ZJuyLCPB0OeztFiBB9lTjcDYS0lUti2RWjyYNi+ZvTe1I97wnEr6Jnt89bHxzZfQ4FnRsGHDKikSPG8PhzJIMIIP9JU4mw8+y/7BbEi3NzAyM153xVPdJ8Pm/dblI2rwETVsIp9TK+lSEMYpCYMfSspok/rmbCkEw8JTSFToxOjJlgG/bjPlPzz+HFdK3xUFiaycbdWS3N2/Lh+SzRQGh0d+bjkvUOPru6Nq8WLAlMPDyezGSlQn1S15CXHz7v76FoMU181Hhd43UVbn/Z0IxQuQVGd036yDQqn3buaGqOreBXjtGd2Q2Gu9INRPljBeInM08wwHgrBmPr8H34XqsXE6jU4rT/giiicCfEQ4rTHDJx501lQSElh47TH9JtCp6ztmEZ8aBKvDpwOa/NxqjW6/6DCuwMgZrbTYYNP6cLI5Rk8Je5kXnZSyq8DZxiTjScGtEh4vLhvzU3L3jCUjMciY2Ac3d2nYS3O1i/rxxc8ZHQ3bDwgkmbsl/Vhu8NJN2TzoB/LGql28V8SC5dO6O6e3lTjcZqnzmEMF2Pa9oWoHm9D+Dpdiw776/oRz27ISQFfc71ZLp63z5vH7W6zeH335o8//hcOvMNxCyEBAA=="; \ No newline at end of file diff --git a/assets/style.css b/assets/style.css index 108428c3..07a385b7 100644 --- a/assets/style.css +++ b/assets/style.css @@ -11,6 +11,7 @@ --light-color-text-aside: #6e6e6e; --light-color-link: #1f70c2; + --light-color-ts-keyword: #056bd6; --light-color-ts-project: #b111c9; --light-color-ts-module: var(--light-color-ts-project); --light-color-ts-namespace: var(--light-color-ts-project); @@ -50,6 +51,7 @@ --dark-color-text-aside: #dddddd; --dark-color-link: #00aff4; + --dark-color-ts-keyword: #3399ff; --dark-color-ts-project: #e358ff; --dark-color-ts-module: var(--dark-color-ts-project); --dark-color-ts-namespace: var(--dark-color-ts-project); @@ -91,6 +93,7 @@ --color-text-aside: var(--light-color-text-aside); --color-link: var(--light-color-link); + --color-ts-keyword: var(--light-color-ts-keyword); --color-ts-module: var(--light-color-ts-module); --color-ts-namespace: var(--light-color-ts-namespace); --color-ts-enum: var(--light-color-ts-enum); @@ -132,6 +135,7 @@ --color-text-aside: var(--dark-color-text-aside); --color-link: var(--dark-color-link); + --color-ts-keyword: var(--dark-color-ts-keyword); --color-ts-module: var(--dark-color-ts-module); --color-ts-namespace: var(--dark-color-ts-namespace); --color-ts-enum: var(--dark-color-ts-enum); @@ -180,6 +184,7 @@ body { --color-text-aside: var(--light-color-text-aside); --color-link: var(--light-color-link); + --color-ts-keyword: var(--light-color-ts-keyword); --color-ts-module: var(--light-color-ts-module); --color-ts-namespace: var(--light-color-ts-namespace); --color-ts-enum: var(--light-color-ts-enum); @@ -219,6 +224,7 @@ body { --color-text-aside: var(--dark-color-text-aside); --color-link: var(--dark-color-link); + --color-ts-keyword: var(--dark-color-ts-keyword); --color-ts-module: var(--dark-color-ts-module); --color-ts-namespace: var(--dark-color-ts-namespace); --color-ts-enum: var(--dark-color-ts-enum); @@ -984,6 +990,11 @@ a.tsd-index-link { overflow-x: auto; } +.tsd-signature-keyword { + color: var(--color-ts-keyword); + font-weight: normal; +} + .tsd-signature-symbol { color: var(--color-text-aside); font-weight: normal; diff --git a/classes/block.Block.html b/classes/block.Block.html index fcde9864..b980458f 100644 --- a/classes/block.Block.html +++ b/classes/block.Block.html @@ -1,8 +1,8 @@ -Block | multiformats

Class Block<T, C, A, V>

Implements

Type Parameters

  • T

    Logical type of the data encoded in the block

    -

  • C

    multicodec code corresponding to codec used to encode the block

    -

  • A

    multicodec code corresponding to the hashing algorithm used in CID creation.

    -

  • V

    CID version

    -

Hierarchy

  • Block

Constructors

constructor +Block | multiformats - v12.1.3

Class Block<T, C, A, V>

Type Parameters

  • T

    Logical type of the data encoded in the block

    +

  • C extends number

    multicodec code corresponding to codec used to encode the block

    +

  • A extends number

    multicodec code corresponding to the hashing algorithm used in CID creation.

    +

  • V extends Version

    CID version

    +

Implements

Constructors

constructor

Properties

asBlock bytes cid @@ -10,4 +10,4 @@

Methods

get links tree -

Constructors

constructor

  • Type Parameters

    • T extends unknown

    • C extends number

    • A extends number

    • V extends Version

    Parameters

    • options: {
          bytes: ByteView<T>;
          cid: CID<T, C, A, V>;
          value: T;
      }

    Returns Block<T, C, A, V>

Properties

asBlock

asBlock: Block<T, C, A, V>

bytes

bytes: ByteView<T>

cid

cid: CID<T, C, A, V>

value

value: {}

Type declaration

    Methods

    get

    links

    tree

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    • new Block<T, C, A, V>(__namedParameters): Block<T, C, A, V>

    • Type Parameters

      • T

      • C extends number

      • A extends number

      • V extends Version

      Parameters

      • __namedParameters: {
            bytes: ByteView<T>;
            cid: CID<T, C, A, V>;
            value: T;
        }

      Returns Block<T, C, A, V>

    Properties

    Readonly asBlock

    asBlock: Block<T, C, A, V>

    Readonly bytes

    bytes: ByteView<T>

    Readonly cid

    cid: CID<T, C, A, V>

    Readonly value

    value: T

    Methods

    get

    links

    tree

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/cid.CID.html b/classes/cid.CID.html index 5577c084..c57e6bca 100644 --- a/classes/cid.CID.html +++ b/classes/cid.CID.html @@ -1,11 +1,16 @@ -CID | multiformats

    Class CID<Data, Format, Alg, Version>

    Implements

    Type Parameters

    • Data = unknown

    • Format = number

    • Alg = number

    • Version = Version

    Hierarchy

    • CID

    Constructors

    constructor +CID | multiformats - v12.1.3

    Class CID<Data, Format, Alg, Version>

    Represents an IPLD link to a specific data of type T.

    +

    Template: T

    Logical type of the data being linked to.

    +

    Template: C

    multicodec code corresponding to a codec linked data is encoded with

    +

    Template: A

    multicodec code corresponding to the hashing algorithm of the CID

    +

    Type Parameters

    • Data = unknown

    • Format extends number = number

    • Alg extends number = number

    • Version extends Version = Version

      CID version

      +

    Implements

    • Link<Data, Format, Alg, Version>

    Constructors

    constructor

    Properties

    / +[toStringTag] bytes code multihash version -

    Accessors

    [toStringTag] -asCID +

    Accessors

    asCID byteLength byteOffset

    Methods

    equals @@ -23,44 +28,43 @@ equals inspectBytes parse -

    Constructors

    constructor

    • Type Parameters

      • Data extends unknown = unknown

      • Format extends number = number

      • Alg extends number = number

      • Version extends Version = Version

      Parameters

      • version: Version

        Version of the CID

        +

    Constructors

    constructor

    Properties

    Readonly /

    /: Uint8Array

    Readonly bytes

    bytes: Uint8Array

    Readonly code

    code: Format

    Readonly multihash

    multihash: MultihashDigest<Alg>

    Readonly version

    version: Version

    Accessors

    [toStringTag]

    asCID

    • get asCID(): this

    • Signalling cid.asCID === cid has been replaced with cid['/'] === cid.bytes +

    • multihash: MultihashDigest<Alg>

      (Multi)hash of the of the content.

      +
    • bytes: Uint8Array

    Returns CID<Data, Format, Alg, Version>

    Properties

    Readonly /

    /: Uint8Array

    Readonly [toStringTag]

    [toStringTag]: "CID" = 'CID'

    Readonly bytes

    bytes: Uint8Array

    Readonly code

    code: Format

    Readonly multihash

    multihash: MultihashDigest<Alg>

    Readonly version

    version: Version

    Accessors

    asCID

    • get asCID(): this

    • Signalling cid.asCID === cid has been replaced with cid['/'] === cid.bytes please either use CID.asCID(cid) or switch to new signalling mechanism

      -

      Returns this

      Deprecated

    byteLength

    byteOffset

    Methods

    equals

    • Parameters

      • other: unknown

      Returns other is CID<Data, Format, Alg, Version>

    link

    • Returns CID<Data, Format, Alg, Version>

    toJSON

    toString

    toV0

    toV1

    Static asCID

    • Takes any input value and returns a CID instance if it was +

      Returns this

      Deprecated

    byteLength

    byteOffset

    Methods

    equals

    • equals(other): other is CID<Data, Format, Alg, Version>

    • Parameters

      • other: unknown

      Returns other is CID<Data, Format, Alg, Version>

    link

    toJSON

    toString

    toV0

    toV1

    Static asCID

    • asCID<Data, Format, Alg, Version, U>(input): null | CID<Data, Format, Alg, Version>

    • Takes any input value and returns a CID instance if it was a CID otherwise returns null. If value is instanceof CID it will return value back. If value is not instance of this CID class, but is compatible CID it will return new instance of this CID class. Otherwise returns null.

      This allows two different incompatible versions of CID library to co-exist and interop as long as binary interface is compatible.

      -

      Type Parameters

      • Data extends unknown

      • Format extends number

      • Alg extends number

      • Version extends Version

      • U extends unknown

      Parameters

      • input: U | Link<Data, Format, Alg, Version>

      Returns null | CID<Data, Format, Alg, Version>

    Static create

    • Type Parameters

      • Data extends unknown

      • Format extends number

      • Alg extends number

      • Version extends Version

      Parameters

      • version: Version

        Version of the CID

        +

        Type Parameters

        • Data

        • Format extends number

        • Alg extends number

        • Version extends Version

        • U

        Parameters

        • input: U | Link<Data, Format, Alg, Version>

        Returns null | CID<Data, Format, Alg, Version>

    Static create

    Static createV0

    • Simplified version of create for CIDv0.

      -

      Type Parameters

      • T extends unknown = unknown

      Parameters

      Returns CID<T, 112, 18, 0>

    Static createV1

    • Simplified version of create for CIDv1.

      -

      Type Parameters

      • Data extends unknown

      • Code extends number

      • Alg extends number

      Parameters

      • code: Code

        Content encoding format code.

        -
      • digest: MultihashDigest<Alg>

        Miltihash of the content.

        -

      Returns CID<Data, Code, Alg, 1>

    Static decode

    • Decoded a CID from its binary representation. The byte array must contain +

    • digest: MultihashDigest<Alg>

      (Multi)hash of the of the content.

      +

    Returns CID<Data, Format, Alg, Version>

    Static createV0

    Static createV1

    Static decode

    Static decodeFirst

    Static decodeFirst

    Static equals

    Static inspectBytes

    Static equals

    Static inspectBytes

    Static parse

    Static parse

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    Parameters

    Returns CID<Data, Code, Alg, Version>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/hashes_digest.Digest.html b/classes/hashes_digest.Digest.html index 61487807..6d4eaeec 100644 --- a/classes/hashes_digest.Digest.html +++ b/classes/hashes_digest.Digest.html @@ -1,9 +1,13 @@ -Digest | multiformats

    Class Digest<Code, Size>

    Represents a multihash digest which carries information about the +Digest | multiformats - v12.1.3

    Class Digest<Code, Size>

    Represents a multihash digest which carries information about the hashing algorithm and an actual hash digest.

    -

    Implements

    Type Parameters

    • Code

    • Size

    Hierarchy

    • Digest

    Constructors

    constructor +

    Type Parameters

    • Code extends number

    • Size extends number

    Implements

    Constructors

    constructor

    Properties

    bytes code digest size -

    Constructors

    constructor

    • Creates a multihash digest.

      -

      Type Parameters

      • Code extends number

      • Size extends number

      Parameters

      Returns Digest<Code, Size>

    Properties

    bytes

    bytes: Uint8Array

    code

    code: Code

    digest

    digest: Uint8Array

    size

    size: Size

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    • new Digest<Code, Size>(code, size, digest, bytes): Digest<Code, Size>

    • Creates a multihash digest.

      +

      Type Parameters

      • Code extends number

      • Size extends number

      Parameters

      Returns Digest<Code, Size>

    Properties

    Readonly bytes

    bytes: Uint8Array

    Binary representation of this multihash digest.

    +

    Readonly code

    code: Code

    Code of the multihash

    +

    Readonly digest

    digest: Uint8Array

    Raw digest (without a hashing algorithm info)

    +

    Readonly size

    size: Size

    byte length of the this.digest

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/hashes_hasher.Hasher.html b/classes/hashes_hasher.Hasher.html index 4ea85427..3d8a72be 100644 --- a/classes/hashes_hasher.Hasher.html +++ b/classes/hashes_hasher.Hasher.html @@ -1,8 +1,14 @@ -Hasher | multiformats

    Class Hasher<Name, Code>

    Hasher represents a hashing algorithm implementation that produces as +Hasher | multiformats - v12.1.3

    Class Hasher<Name, Code>

    Hasher represents a hashing algorithm implementation that produces as MultihashDigest.

    -

    Implements

    Type Parameters

    • Name

    • Code

    Hierarchy

    • Hasher

    Constructors

    constructor +

    Type Parameters

    • Name extends string

    • Code extends number

    Implements

    Constructors

    constructor

    Properties

    code encode name

    Methods

    digest -

    Constructors

    constructor

    Properties

    code

    code: Code

    encode

    encode: ((input) => Await<Uint8Array>)

    Type declaration

    name

    name: Name

    Methods

    digest

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Readonly code

    code: Code

    Code of the multihash

    +

    Readonly encode

    encode: ((input) => Await<Uint8Array>)

    Type declaration

    Readonly name

    name: Name

    Name of the multihash

    +

    Methods

    digest

    • digest(input): Await<Digest<Code, number>>

    • Takes binary input and returns it (multi) hash digest. Return value is +either promise of a digest or a digest. This way general use can await +while performance critical code may asses return value to decide whether +await is needed.

      +

      Parameters

      Returns Await<Digest<Code, number>>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/block.create.html b/functions/block.create.html index f3abcc9f..dc08f0a7 100644 --- a/functions/block.create.html +++ b/functions/block.create.html @@ -1,5 +1,5 @@ -create | multiformats

    Function create

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/block.createUnsafe.html b/functions/block.createUnsafe.html index aedf985e..c20bfecf 100644 --- a/functions/block.createUnsafe.html +++ b/functions/block.createUnsafe.html @@ -1,5 +1,5 @@ -createUnsafe | multiformats

    Function createUnsafe

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/block.decode.html b/functions/block.decode.html index 8a9d9546..fd45c85b 100644 --- a/functions/block.decode.html +++ b/functions/block.decode.html @@ -1,4 +1,4 @@ -decode | multiformats

    Function decode

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/block.encode.html b/functions/block.encode.html index 54a4cd30..44a6d638 100644 --- a/functions/block.encode.html +++ b/functions/block.encode.html @@ -1,4 +1,4 @@ -encode | multiformats

    Function encode

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/bytes.coerce.html b/functions/bytes.coerce.html index 83da129f..269affa6 100644 --- a/functions/bytes.coerce.html +++ b/functions/bytes.coerce.html @@ -1 +1 @@ -coerce | multiformats

    Function coerce

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +coerce | multiformats - v12.1.3

    Function coerce

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/bytes.equals.html b/functions/bytes.equals.html index f644d2e8..94544bcf 100644 --- a/functions/bytes.equals.html +++ b/functions/bytes.equals.html @@ -1 +1 @@ -equals | multiformats

    Function equals

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +equals | multiformats - v12.1.3

    Function equals

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/bytes.fromHex.html b/functions/bytes.fromHex.html index 72b22a2f..a62233ce 100644 --- a/functions/bytes.fromHex.html +++ b/functions/bytes.fromHex.html @@ -1 +1 @@ -fromHex | multiformats

    Function fromHex

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +fromHex | multiformats - v12.1.3

    Function fromHex

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/bytes.fromString.html b/functions/bytes.fromString.html index de8537fd..36607630 100644 --- a/functions/bytes.fromString.html +++ b/functions/bytes.fromString.html @@ -1 +1 @@ -fromString | multiformats

    Function fromString

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +fromString | multiformats - v12.1.3

    Function fromString

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/bytes.isBinary.html b/functions/bytes.isBinary.html index 9f7360ea..d95f37be 100644 --- a/functions/bytes.isBinary.html +++ b/functions/bytes.isBinary.html @@ -1 +1 @@ -isBinary | multiformats

    Function isBinary

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +isBinary | multiformats - v12.1.3

    Function isBinary

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/bytes.toHex.html b/functions/bytes.toHex.html index d01868c3..92c0aa87 100644 --- a/functions/bytes.toHex.html +++ b/functions/bytes.toHex.html @@ -1 +1 @@ -toHex | multiformats

    Function toHex

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +toHex | multiformats - v12.1.3

    Function toHex

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/bytes.toString.html b/functions/bytes.toString.html index da55e364..6f93bb24 100644 --- a/functions/bytes.toString.html +++ b/functions/bytes.toString.html @@ -1 +1 @@ -toString | multiformats

    Function toString

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +toString | multiformats - v12.1.3

    Function toString

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/cid.format.html b/functions/cid.format.html index 6cde4629..a70b0f4c 100644 --- a/functions/cid.format.html +++ b/functions/cid.format.html @@ -1 +1 @@ -format | multiformats

    Function format

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +format | multiformats - v12.1.3

    Function format

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/cid.fromJSON.html b/functions/cid.fromJSON.html index 72ad96db..9bd175ea 100644 --- a/functions/cid.fromJSON.html +++ b/functions/cid.fromJSON.html @@ -1 +1 @@ -fromJSON | multiformats

    Function fromJSON

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +fromJSON | multiformats - v12.1.3

    Function fromJSON

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/cid.toJSON.html b/functions/cid.toJSON.html index cdf1da19..f6ae245e 100644 --- a/functions/cid.toJSON.html +++ b/functions/cid.toJSON.html @@ -1 +1 @@ -toJSON | multiformats

    Function toJSON

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +toJSON | multiformats - v12.1.3

    Function toJSON

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/codecs_json.decode.html b/functions/codecs_json.decode.html index 653d709c..579cccc2 100644 --- a/functions/codecs_json.decode.html +++ b/functions/codecs_json.decode.html @@ -1 +1 @@ -decode | multiformats

    Function decode

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +decode | multiformats - v12.1.3

    Function decode

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/codecs_json.encode.html b/functions/codecs_json.encode.html index 2c250d32..f1c9dbb6 100644 --- a/functions/codecs_json.encode.html +++ b/functions/codecs_json.encode.html @@ -1 +1 @@ -encode | multiformats

    Function encode

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +encode | multiformats - v12.1.3

    Function encode

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/codecs_raw.decode.html b/functions/codecs_raw.decode.html index 84f268ad..85b43826 100644 --- a/functions/codecs_raw.decode.html +++ b/functions/codecs_raw.decode.html @@ -1 +1 @@ -decode | multiformats

    Function decode

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +decode | multiformats - v12.1.3

    Function decode

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/codecs_raw.encode.html b/functions/codecs_raw.encode.html index e174c28d..62b35aab 100644 --- a/functions/codecs_raw.encode.html +++ b/functions/codecs_raw.encode.html @@ -1 +1 @@ -encode | multiformats

    Function encode

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +encode | multiformats - v12.1.3

    Function encode

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/hashes_digest.create.html b/functions/hashes_digest.create.html index b0c48bbd..d7106347 100644 --- a/functions/hashes_digest.create.html +++ b/functions/hashes_digest.create.html @@ -1,2 +1,2 @@ -create | multiformats

    Function create

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +create | multiformats - v12.1.3

    Function create

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/hashes_digest.decode.html b/functions/hashes_digest.decode.html index f3defa0a..fa4b0371 100644 --- a/functions/hashes_digest.decode.html +++ b/functions/hashes_digest.decode.html @@ -1,2 +1,2 @@ -decode | multiformats

    Function decode

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +decode | multiformats - v12.1.3

    Function decode

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/hashes_digest.equals.html b/functions/hashes_digest.equals.html index fd9c90da..4b4829b5 100644 --- a/functions/hashes_digest.equals.html +++ b/functions/hashes_digest.equals.html @@ -1 +1 @@ -equals | multiformats

    Function equals

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +equals | multiformats - v12.1.3

    Function equals

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/hashes_hasher.from.html b/functions/hashes_hasher.from.html index 39172967..ee8b86dd 100644 --- a/functions/hashes_hasher.from.html +++ b/functions/hashes_hasher.from.html @@ -1 +1 @@ -from | multiformats

    Function from

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +from | multiformats - v12.1.3

    Function from

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/index.varint.decode.html b/functions/index.varint.decode.html index d4187fba..b4062f97 100644 --- a/functions/index.varint.decode.html +++ b/functions/index.varint.decode.html @@ -1 +1 @@ -decode | multiformats

    Function decode

    • Parameters

      Returns [number, number]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +decode | multiformats - v12.1.3

    Function decode

    • decode(data, offset?): [number, number]

    • Parameters

      Returns [number, number]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/index.varint.encodeTo.html b/functions/index.varint.encodeTo.html index a58b6c7e..9078fa47 100644 --- a/functions/index.varint.encodeTo.html +++ b/functions/index.varint.encodeTo.html @@ -1 +1 @@ -encodeTo | multiformats

    Function encodeTo

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +encodeTo | multiformats - v12.1.3

    Function encodeTo

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/index.varint.encodingLength.html b/functions/index.varint.encodingLength.html index 1628ae1a..d96435dc 100644 --- a/functions/index.varint.encodingLength.html +++ b/functions/index.varint.encodingLength.html @@ -1 +1 @@ -encodingLength | multiformats

    Function encodingLength

    • Parameters

      • int: number

      Returns number

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +encodingLength | multiformats - v12.1.3

    Function encodingLength

    • encodingLength(int): number

    • Parameters

      • int: number

      Returns number

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/link.create.html b/functions/link.create.html index a045193d..27f90550 100644 --- a/functions/link.create.html +++ b/functions/link.create.html @@ -1,4 +1,4 @@ -create | multiformats

    Function create

    • Simplified version of create for CIDv1.

      -

      Type Parameters

      • Data extends unknown

      • Code extends number

      • Alg extends number

      Parameters

      • code: Code

        Content encoding format code.

        -
      • digest: MultihashDigest<Alg>

        Miltihash of the content.

        -

      Returns Link<Data, Code, Alg, 1>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +create | multiformats - v12.1.3

    Function create

    • create<Data, Code, Alg>(code, digest): Link<Data, Code, Alg>

    • Simplified version of create for CIDv1.

      +

      Type Parameters

      • Data

      • Code extends number

      • Alg extends number

      Parameters

      • code: Code

        Content encoding format code.

        +
      • digest: MultihashDigest<Alg>

        Miltihash of the content.

        +

      Returns Link<Data, Code, Alg>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/link.createLegacy.html b/functions/link.createLegacy.html index ebd78388..62c958bb 100644 --- a/functions/link.createLegacy.html +++ b/functions/link.createLegacy.html @@ -1,3 +1,2 @@ -createLegacy | multiformats

    Function createLegacy

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +createLegacy | multiformats - v12.1.3

    Function createLegacy

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/link.decode.html b/functions/link.decode.html index 00230297..9f54b046 100644 --- a/functions/link.decode.html +++ b/functions/link.decode.html @@ -1,5 +1,5 @@ -decode | multiformats

    Function decode

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/link.isLink.html b/functions/link.isLink.html index c08eeb1b..1175f10a 100644 --- a/functions/link.isLink.html +++ b/functions/link.isLink.html @@ -1,2 +1,2 @@ -isLink | multiformats

    Function isLink

    • Type predicate returns true if value is the link.

      -

      Type Parameters

      • L extends Link<unknown, number, number, 0 | 1>

      Parameters

      • value: unknown

      Returns value is L & CID<any, number, number, Version>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +isLink | multiformats - v12.1.3

    Function isLink

    • isLink<L>(value): value is L & CID<unknown, number, number, Version>

    • Type predicate returns true if value is the link.

      +

      Type Parameters

      • L extends Link<unknown, number, number, 0 | 1>

      Parameters

      • value: unknown

      Returns value is L & CID<unknown, number, number, Version>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/link.parse.html b/functions/link.parse.html index 59ed6ced..57b2439a 100644 --- a/functions/link.parse.html +++ b/functions/link.parse.html @@ -1,5 +1,5 @@ -parse | multiformats

    Function parse

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/traversal.walk.html b/functions/traversal.walk.html index 81c84f05..ef3b0937 100644 --- a/functions/traversal.walk.html +++ b/functions/traversal.walk.html @@ -1 +1 @@ -walk | multiformats

    Function walk

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +walk | multiformats - v12.1.3

    Function walk

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/index.html b/index.html index c7f9adb9..44c3257f 100644 --- a/index.html +++ b/index.html @@ -1,72 +1,43 @@ -multiformats

    multiformats

    multiformats

    multiformats.io +multiformats - v12.1.3

    multiformats - v12.1.3

    multiformats.io codecov CI

    Interface for multihash, multicodec, multibase and CID

    -

    Table of contents

    -

    Install

    $ npm i multiformats
-
    -

    Browser <script> tag

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

    -
    <script src="https://unpkg.com/multiformats/dist/index.min.js"></script>
-
    -

    Interfaces

    This library defines common interfaces and low level building blocks for various interrelated multiformat technologies (multicodec, multihash, multibase, and CID). They can be used to implement custom base encoders / decoders / codecs, codec encoders /decoders and multihash hashers that comply to the interface that layers above assume.

    +

    About

    This library defines common interfaces and low level building blocks for various interrelated multiformat technologies (multicodec, multihash, multibase, and CID). They can be used to implement custom base encoders / decoders / codecs, codec encoders /decoders and multihash hashers that comply to the interface that layers above assume.

    This library provides implementations for most basics and many others can be found in linked repositories.

    -
    import { CID } from 'multiformats/cid'
    import * as json from 'multiformats/codecs/json'
    import { sha256 } from 'multiformats/hashes/sha2'

    const bytes = json.encode({ hello: 'world' })

    const hash = await sha256.digest(bytes)
    const cid = CID.create(1, json.code, hash)
    //> CID(bagaaierasords4njcts6vs7qvdjfcvgnume4hqohf65zsfguprqphs3icwea)
+
    import { CID } from 'multiformats/cid'
    import * as json from 'multiformats/codecs/json'
    import { sha256 } from 'multiformats/hashes/sha2'

    const bytes = json.encode({ hello: 'world' })

    const hash = await sha256.digest(bytes)
    const cid = CID.create(1, json.code, hash)
    //> CID(bagaaierasords4njcts6vs7qvdjfcvgnume4hqohf65zsfguprqphs3icwea)
 
    
-
    Creating Blocks
    import * as Block from 'multiformats/block'
    import * as codec from '@ipld/dag-cbor'
    import { sha256 as hasher } from 'multiformats/hashes/sha2'

    const value = { hello: 'world' }

    // encode a block
    let block = await Block.encode({ value, codec, hasher })

    block.value // { hello: 'world' }
    block.bytes // Uint8Array
    block.cid   // CID() w/ sha2-256 hash address and dag-cbor codec

    // you can also decode blocks from their binary state
    block = await Block.decode({ bytes: block.bytes, codec, hasher })

    // if you have the cid you can also verify the hash on decode
    block = await Block.create({ bytes: block.bytes, cid: block.cid, codec, hasher })
+
    Creating Blocks
    import * as Block from 'multiformats/block'
    import * as codec from '@ipld/dag-cbor'
    import { sha256 as hasher } from 'multiformats/hashes/sha2'

    const value = { hello: 'world' }

    // encode a block
    let block = await Block.encode({ value, codec, hasher })

    block.value // { hello: 'world' }
    block.bytes // Uint8Array
    block.cid   // CID() w/ sha2-256 hash address and dag-cbor codec

    // you can also decode blocks from their binary state
    block = await Block.decode({ bytes: block.bytes, codec, hasher })

    // if you have the cid you can also verify the hash on decode
    block = await Block.create({ bytes: block.bytes, cid: block.cid, codec, hasher })
 
    
-
    Multibase Encoders / Decoders / Codecs
    CIDs can be serialized to string representation using multibase encoders that implement MultibaseEncoder interface. This library provides quite a few implementations that can be imported:
    
-
    import { base64 } from "multiformats/bases/base64"
    cid.toString(base64.encoder)
    //> 'mAYAEEiCTojlxqRTl6svwqNJRVM2jCcPBxy+7mRTUfGDzy2gViA'
+
    Multibase Encoders / Decoders / Codecs
    CIDs can be serialized to string representation using multibase encoders that implement MultibaseEncoder interface. This library provides quite a few implementations that can be imported:
    
+
    import { base64 } from "multiformats/bases/base64"
    cid.toString(base64.encoder)
    //> 'mAYAEEiCTojlxqRTl6svwqNJRVM2jCcPBxy+7mRTUfGDzy2gViA'
 
    
 
    Parsing CID string serialized CIDs requires multibase decoder that implements MultibaseDecoder interface. This library provides a decoder for every encoder it provides:
    
-
    CID.parse('mAYAEEiCTojlxqRTl6svwqNJRVM2jCcPBxy+7mRTUfGDzy2gViA', base64.decoder)
    //> CID(bagaaierasords4njcts6vs7qvdjfcvgnume4hqohf65zsfguprqphs3icwea)
+
    CID.parse('mAYAEEiCTojlxqRTl6svwqNJRVM2jCcPBxy+7mRTUfGDzy2gViA', base64.decoder)
    //> CID(bagaaierasords4njcts6vs7qvdjfcvgnume4hqohf65zsfguprqphs3icwea)
 
    
 
    Dual of multibase encoder & decoder is defined as multibase codec and it exposes
 them as encoder and decoder properties. For added convenience codecs also
 implement MultibaseEncoder and MultibaseDecoder interfaces so they could be
 used as either or both:
    
-
    cid.toString(base64)
    CID.parse(cid.toString(base64), base64)
+
    cid.toString(base64)
    CID.parse(cid.toString(base64), base64)
 
    
 
    Note: CID implementation comes bundled with base32 and base58btc
 multibase codecs so that CIDs can be base serialized to (version specific)
 default base encoding and parsed without having to supply base encoders/decoders:
    
-
    const v1 = CID.parse('bagaaierasords4njcts6vs7qvdjfcvgnume4hqohf65zsfguprqphs3icwea')
    v1.toString()
    //> 'bagaaierasords4njcts6vs7qvdjfcvgnume4hqohf65zsfguprqphs3icwea'

    const v0 = CID.parse('QmdfTbBqBPQ7VNxZEYEj14VmRuZBkqFbiwReogJgS1zR1n')
    v0.toString()
    //> 'QmdfTbBqBPQ7VNxZEYEj14VmRuZBkqFbiwReogJgS1zR1n'
    v0.toV1().toString()
    //> 'bafybeihdwdcefgh4dqkjv67uzcmw7ojee6xedzdetojuzjevtenxquvyku'
+
    const v1 = CID.parse('bagaaierasords4njcts6vs7qvdjfcvgnume4hqohf65zsfguprqphs3icwea')
    v1.toString()
    //> 'bagaaierasords4njcts6vs7qvdjfcvgnume4hqohf65zsfguprqphs3icwea'

    const v0 = CID.parse('QmdfTbBqBPQ7VNxZEYEj14VmRuZBkqFbiwReogJgS1zR1n')
    v0.toString()
    //> 'QmdfTbBqBPQ7VNxZEYEj14VmRuZBkqFbiwReogJgS1zR1n'
    v0.toV1().toString()
    //> 'bafybeihdwdcefgh4dqkjv67uzcmw7ojee6xedzdetojuzjevtenxquvyku'
 
    
-
    Multicodec Encoders / Decoders / Codecs
    This library defines BlockEncoder, BlockDecoder and BlockCodec interfaces.
+
    Multicodec Encoders / Decoders / Codecs
    This library defines BlockEncoder, BlockDecoder and BlockCodec interfaces.
 Codec implementations should conform to the BlockCodec interface which implements both BlockEncoder and BlockDecoder.
 Here is an example implementation of JSON BlockCodec.
    
-
    /**
     * @template T
     * @type {BlockCodec<0x0200, T>}
     */
    export const { name, code, encode, decode } = {
      name: 'json',
      code: 0x0200,
      encode: json => new TextEncoder().encode(JSON.stringify(json)),
      decode: bytes => JSON.parse(new TextDecoder().decode(bytes))
    }
+
    export const { name, code, encode, decode } = {
      name: 'json',
      code: 0x0200,
      encode: json => new TextEncoder().encode(JSON.stringify(json)),
      decode: bytes => JSON.parse(new TextDecoder().decode(bytes))
    }
 
    
-
    Multihash Hashers
    This library defines MultihashHasher and MultihashDigest interfaces and convinient function for implementing them:
    
-
    import * as hasher from 'multiformats/hashes/hasher'

    const sha256 = hasher.from({
      // As per multiformats table
      // https://github.com/multiformats/multicodec/blob/master/table.csv#L9
      name: 'sha2-256',
      code: 0x12,

      encode: (input) => new Uint8Array(crypto.createHash('sha256').update(input).digest())
    })

    const hash = await sha256.digest(json.encode({ hello: 'world' }))
    CID.create(1, json.code, hash)

    //> CID(bagaaierasords4njcts6vs7qvdjfcvgnume4hqohf65zsfguprqphs3icwea)
+
    Multihash Hashers
    This library defines MultihashHasher and MultihashDigest interfaces and convinient function for implementing them:
    
+
    import * as hasher from 'multiformats/hashes/hasher'

    const sha256 = hasher.from({
      // As per multiformats table
      // https://github.com/multiformats/multicodec/blob/master/table.csv#L9
      name: 'sha2-256',
      code: 0x12,

      encode: (input) => new Uint8Array(crypto.createHash('sha256').update(input).digest())
    })

    const hash = await sha256.digest(json.encode({ hello: 'world' }))
    CID.create(1, json.code, hash)

    //> CID(bagaaierasords4njcts6vs7qvdjfcvgnume4hqohf65zsfguprqphs3icwea)
 
    
-
    Traversal
    This library contains higher-order functions for traversing graphs of data easily.
    
+
    Traversal
    This library contains higher-order functions for traversing graphs of data easily.
    
 
    walk() walks through the links in each block of a DAG calling a user-supplied loader function for each one, in depth-first order with no duplicate block visits. The loader should return a Block object and can be used to inspect and collect block ordering for a full DAG walk. The loader should throw on error, and return null if a block should be skipped by walk().
    
-
    import { walk } from 'multiformats/traversal'
    import * as Block from 'multiformats/block'
    import * as codec from 'multiformats/codecs/json'
    import { sha256 as hasher } from 'multiformats/hashes/sha2'

    // build a DAG (a single block for this simple example)
    const value = { hello: 'world' }
    const block = await Block.encode({ value, codec, hasher })
    const { cid } = block
    console.log(cid)
    //> CID(bagaaierasords4njcts6vs7qvdjfcvgnume4hqohf65zsfguprqphs3icwea)

    // create a loader function that also collects CIDs of blocks in
    // their traversal order
    const load = (cid, blocks) => async (cid) => {
      // fetch a block using its cid
      // e.g.: const block = await fetchBlockByCID(cid)
      blocks.push(cid)
      return block
    }

    // collect blocks in this DAG starting from the root `cid`
    const blocks = []
    await walk({ cid, load: load(cid, blocks) })

    console.log(blocks)
    //> [CID(bagaaierasords4njcts6vs7qvdjfcvgnume4hqohf65zsfguprqphs3icwea)]
+
    import { walk } from 'multiformats/traversal'
    import * as Block from 'multiformats/block'
    import * as codec from 'multiformats/codecs/json'
    import { sha256 as hasher } from 'multiformats/hashes/sha2'

    // build a DAG (a single block for this simple example)
    const value = { hello: 'world' }
    const block = await Block.encode({ value, codec, hasher })
    const { cid } = block
    console.log(cid)
    //> CID(bagaaierasords4njcts6vs7qvdjfcvgnume4hqohf65zsfguprqphs3icwea)

    // create a loader function that also collects CIDs of blocks in
    // their traversal order
    const load = (cid, blocks) => async (cid) => {
      // fetch a block using its cid
      // e.g.: const block = await fetchBlockByCID(cid)
      blocks.push(cid)
      return block
    }

    // collect blocks in this DAG starting from the root `cid`
    const blocks = []
    await walk({ cid, load: load(cid, blocks) })

    console.log(blocks)
    //> [CID(bagaaierasords4njcts6vs7qvdjfcvgnume4hqohf65zsfguprqphs3icwea)]
 
    
 
    Legacy interface
    blockcodec-to-ipld-format converts a multiformats BlockCodec into an
 interface-ipld-format for use with the ipld package. This can help bridge IPLD codecs implemented using the structure and interfaces defined here to existing code that assumes, or requires interface-ipld-format. This bridge also includes the relevant TypeScript definitions.
    
@@ -176,13 +147,18 @@
 ceramicnetwork/js-dag-jose
 
 
-
    API Docs

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Contribution

    Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/bases_interface.BaseCodec.html b/interfaces/bases_interface.BaseCodec.html new file mode 100644 index 00000000..8b224043 --- /dev/null +++ b/interfaces/bases_interface.BaseCodec.html @@ -0,0 +1,4 @@ +BaseCodec | multiformats - v12.1.3

    Interface BaseCodec

    Base codec is just dual of encoder and decoder.

    +
    interface BaseCodec {
        decoder: BaseDecoder;
        encoder: BaseEncoder;
    }

    Properties

    decoder +encoder +

    Properties

    decoder

    decoder: BaseDecoder

    encoder

    encoder: BaseEncoder

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/bases_interface.BaseDecoder.html b/interfaces/bases_interface.BaseDecoder.html new file mode 100644 index 00000000..03f27679 --- /dev/null +++ b/interfaces/bases_interface.BaseDecoder.html @@ -0,0 +1,5 @@ +BaseDecoder | multiformats - v12.1.3

    Interface BaseDecoder

    Base decoder decodes encoded with matching base encoding into bytes.

    +
    interface BaseDecoder {
        baseDecode(text): Uint8Array;
    }

    Methods

    baseDecode +

    Methods

    baseDecode

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/block.RequiredCreateOptions.html b/interfaces/bases_interface.BaseEncoder.html similarity index 60% rename from interfaces/block.RequiredCreateOptions.html rename to interfaces/bases_interface.BaseEncoder.html index 8fba532f..1f7f5d4a 100644 --- a/interfaces/block.RequiredCreateOptions.html +++ b/interfaces/bases_interface.BaseEncoder.html @@ -1,2 +1,5 @@ -RequiredCreateOptions | multiformats

    Interface RequiredCreateOptions

    Hierarchy

    • RequiredCreateOptions

    Properties

    cid -

    Properties

    cid

    cid: CID<any, number, number, Version>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +BaseEncoder | multiformats - v12.1.3

    Interface BaseEncoder

    Base encoder just encodes bytes into base encoded string.

    +
    interface BaseEncoder {
        baseEncode(bytes): string;
    }

    Methods

    baseEncode +

    Methods

    baseEncode

    • baseEncode(bytes): string

    • Base encodes to a plain (and not a multibase) string. Unlike +encode no multibase prefix is added.

      +

      Parameters

      Returns string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/bases_interface.CombobaseDecoder.html b/interfaces/bases_interface.CombobaseDecoder.html new file mode 100644 index 00000000..b8f3c35e --- /dev/null +++ b/interfaces/bases_interface.CombobaseDecoder.html @@ -0,0 +1,9 @@ +CombobaseDecoder | multiformats - v12.1.3

    Interface CombobaseDecoder<Prefix>

    Interface implemented by multibase decoder, that takes multibase strings +to bytes. It may support single encoding like base32 or multiple encodings +like base32, base58btc, base64. If passed multibase is incompatible it will +throw an exception.

    +
    interface CombobaseDecoder {
        decoders: Record<Prefix, UnibaseDecoder<Prefix>>;
        decode(multibase): Uint8Array;
    }

    Type Parameters

    • Prefix extends string

    Hierarchy

    Properties

    decoders +

    Methods

    decode +

    Properties

    Readonly decoders

    decoders: Record<Prefix, UnibaseDecoder<Prefix>>

    Methods

    decode

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/bases_interface.MultibaseCodec.html b/interfaces/bases_interface.MultibaseCodec.html new file mode 100644 index 00000000..ac5419b4 --- /dev/null +++ b/interfaces/bases_interface.MultibaseCodec.html @@ -0,0 +1,6 @@ +MultibaseCodec | multiformats - v12.1.3

    Interface MultibaseCodec<Prefix>

    Dual of multibase encoder and decoder.

    +
    interface MultibaseCodec {
        decoder: MultibaseDecoder<Prefix>;
        encoder: MultibaseEncoder<Prefix>;
        name: string;
        prefix: Prefix;
    }

    Type Parameters

    • Prefix extends string

    Properties

    decoder +encoder +name +prefix +

    Properties

    decoder

    decoder: MultibaseDecoder<Prefix>

    encoder

    encoder: MultibaseEncoder<Prefix>

    name

    name: string

    prefix

    prefix: Prefix

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/index.BaseEncoder.html b/interfaces/bases_interface.MultibaseDecoder.html similarity index 53% rename from interfaces/index.BaseEncoder.html rename to interfaces/bases_interface.MultibaseDecoder.html index a198a4e0..85cd8f3a 100644 --- a/interfaces/index.BaseEncoder.html +++ b/interfaces/bases_interface.MultibaseDecoder.html @@ -1,5 +1,8 @@ -BaseEncoder | multiformats

    Interface BaseEncoder

    Base encoder just encodes bytes into base encoded string.

    -

    Hierarchy

    • BaseEncoder

    Methods

    baseEncode -

    Methods

    baseEncode

    • Base encodes to a plain (and not a multibase) string. Unlike -encode no multibase prefix is added.

      -

      Parameters

      Returns string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +MultibaseDecoder | multiformats - v12.1.3

    Interface MultibaseDecoder<Prefix>

    Interface implemented by multibase decoder, that takes multibase strings +to bytes. It may support single encoding like base32 or multiple encodings +like base32, base58btc, base64. If passed multibase is incompatible it will +throw an exception.

    +
    interface MultibaseDecoder {
        decode(multibase): Uint8Array;
    }

    Type Parameters

    • Prefix extends string

    Hierarchy

    Methods

    decode +

    Methods

    decode

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/bases_interface.MultibaseEncoder.html b/interfaces/bases_interface.MultibaseEncoder.html new file mode 100644 index 00000000..6698f792 --- /dev/null +++ b/interfaces/bases_interface.MultibaseEncoder.html @@ -0,0 +1,10 @@ +MultibaseEncoder | multiformats - v12.1.3

    Interface MultibaseEncoder<Prefix>

    Multibase encoder for the specific base encoding encodes bytes into +multibase of that encoding.

    +
    interface MultibaseEncoder {
        name: string;
        prefix: Prefix;
        encode(bytes): Multibase<Prefix>;
    }

    Type Parameters

    • Prefix extends string

    Properties

    name +prefix +

    Methods

    encode +

    Properties

    name

    name: string

    Name of the encoding.

    +

    prefix

    prefix: Prefix

    Prefix character for that base encoding.

    +

    Methods

    encode

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/bases_interface.UnibaseDecoder.html b/interfaces/bases_interface.UnibaseDecoder.html new file mode 100644 index 00000000..d2717490 --- /dev/null +++ b/interfaces/bases_interface.UnibaseDecoder.html @@ -0,0 +1,10 @@ +UnibaseDecoder | multiformats - v12.1.3

    Interface UnibaseDecoder<Prefix>

    Interface implemented by multibase decoder, that takes multibase strings +to bytes. It may support single encoding like base32 or multiple encodings +like base32, base58btc, base64. If passed multibase is incompatible it will +throw an exception.

    +
    interface UnibaseDecoder {
        decoders?: null;
        prefix: Prefix;
        decode(multibase): Uint8Array;
    }

    Type Parameters

    • Prefix extends string

    Hierarchy

    Properties

    decoders? +prefix +

    Methods

    decode +

    Properties

    Optional Readonly decoders

    decoders?: null

    Readonly prefix

    prefix: Prefix

    Methods

    decode

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/block_interface.Block.html b/interfaces/block_interface.Block.html new file mode 100644 index 00000000..55281487 --- /dev/null +++ b/interfaces/block_interface.Block.html @@ -0,0 +1,9 @@ +Block | multiformats - v12.1.3

    Interface Block<T, C, A, V>

    Represents an IPLD block (including its CID) that can be decoded to data of +type T.

    +
    interface Block {
        bytes: ByteView<T>;
        cid: Link<T, C, A, V>;
    }

    Type Parameters

    • T = unknown

      Logical type of the data encoded in the block

      +

    • C extends number = number

      multicodec code corresponding to codec used to encode the block

      +

    • A extends number = number

      multicodec code corresponding to the hashing algorithm used in CID creation.

      +

    • V extends Version = 1

      CID version

      +

    Hierarchy

    Properties

    bytes +cid +

    Properties

    bytes

    bytes: ByteView<T>

    cid

    cid: Link<T, C, A, V>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/block_interface.BlockView.html b/interfaces/block_interface.BlockView.html new file mode 100644 index 00000000..bbb01a58 --- /dev/null +++ b/interfaces/block_interface.BlockView.html @@ -0,0 +1,13 @@ +BlockView | multiformats - v12.1.3

    Interface BlockView<T, C, A, V>

    Represents an IPLD block (including its CID) that can be decoded to data of +type T.

    +
    interface BlockView {
        bytes: ByteView<T>;
        cid: CID<T, C, A, V>;
        value: T;
        get(path): BlockCursorView<unknown>;
        links(): Iterable<[string, CID<unknown, number, number, Version>]>;
        tree(): Iterable<string>;
    }

    Type Parameters

    • T = unknown

      Logical type of the data encoded in the block

      +

    • C extends number = number

      multicodec code corresponding to codec used to encode the block

      +

    • A extends number = number

      multicodec code corresponding to the hashing algorithm used in CID creation.

      +

    • V extends Version = 1

      CID version

      +

    Hierarchy

    • Block<T, C, A, V>
      • BlockView

    Implemented by

    Properties

    bytes +cid +value +

    Methods

    get +links +tree +

    Properties

    bytes

    bytes: ByteView<T>

    cid

    cid: CID<T, C, A, V>

    value

    value: T

    Methods

    get

    links

    tree

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/block_interface.ByteView.html b/interfaces/block_interface.ByteView.html new file mode 100644 index 00000000..d56f92dd --- /dev/null +++ b/interfaces/block_interface.ByteView.html @@ -0,0 +1,166 @@ +ByteView | multiformats - v12.1.3

    Interface ByteView<Data>

    A byte-encoded representation of some type of Data.

    +

    A ByteView is essentially a Uint8Array that's been "tagged" with +a Data type parameter indicating the type of encoded data.

    +

    For example, a ByteView<{ hello: "world" }> is a Uint8Array containing a +binary representation of a {hello: "world"}.

    +
    interface ByteView {
        BYTES_PER_ELEMENT: number;
        [Marker]?: Data;
        [toStringTag]: "Uint8Array";
        buffer: ArrayBufferLike;
        byteLength: number;
        byteOffset: number;
        length: number;
        [iterator](): IterableIterator<number>;
        at(index): undefined | number;
        copyWithin(target, start, end?): ByteView<Data>;
        entries(): IterableIterator<[number, number]>;
        every(predicate, thisArg?): boolean;
        fill(value, start?, end?): ByteView<Data>;
        filter(predicate, thisArg?): Uint8Array;
        find(predicate, thisArg?): undefined | number;
        findIndex(predicate, thisArg?): number;
        forEach(callbackfn, thisArg?): void;
        includes(searchElement, fromIndex?): boolean;
        indexOf(searchElement, fromIndex?): number;
        join(separator?): string;
        keys(): IterableIterator<number>;
        lastIndexOf(searchElement, fromIndex?): number;
        map(callbackfn, thisArg?): Uint8Array;
        reduce(callbackfn): number;
        reduce(callbackfn, initialValue): number;
        reduce<U>(callbackfn, initialValue): U;
        reduceRight(callbackfn): number;
        reduceRight(callbackfn, initialValue): number;
        reduceRight<U>(callbackfn, initialValue): U;
        reverse(): Uint8Array;
        set(array, offset?): void;
        slice(start?, end?): Uint8Array;
        some(predicate, thisArg?): boolean;
        sort(compareFn?): ByteView<Data>;
        subarray(begin?, end?): Uint8Array;
        toLocaleString(): string;
        toString(): string;
        valueOf(): Uint8Array;
        values(): IterableIterator<number>;
    }

    Type Parameters

    • Data

    Hierarchy

    Properties

    BYTES_PER_ELEMENT +[Marker]? +[toStringTag] +buffer +byteLength +byteOffset +length +

    Methods

    [iterator] +at +copyWithin +entries +every +fill +filter +find +findIndex +forEach +includes +indexOf +join +keys +lastIndexOf +map +reduce +reduceRight +reverse +set +slice +some +sort +subarray +toLocaleString +toString +valueOf +values +

    Properties

    Readonly BYTES_PER_ELEMENT

    BYTES_PER_ELEMENT: number

    The size in bytes of each element in the array.

    +

    Optional [Marker]

    [Marker]?: Data

    Readonly [toStringTag]

    [toStringTag]: "Uint8Array"

    Readonly buffer

    buffer: ArrayBufferLike

    The ArrayBuffer instance referenced by the array.

    +

    Readonly byteLength

    byteLength: number

    The length in bytes of the array.

    +

    Readonly byteOffset

    byteOffset: number

    The offset in bytes of the array.

    +

    Readonly length

    length: number

    The length of the array.

    +

    Methods

    [iterator]

    • [iterator](): IterableIterator<number>

    • Returns IterableIterator<number>

    at

    • at(index): undefined | number

    • Returns the item located at the specified index.

      +

      Parameters

      • index: number

        The zero-based index of the desired code unit. A negative index will count back from the last item.

        +

      Returns undefined | number

    copyWithin

    • copyWithin(target, start, end?): ByteView<Data>

    • Returns the this object after copying a section of the array identified by start and end +to the same array starting at position target

      +

      Parameters

      • target: number

        If target is negative, it is treated as length+target where length is the +length of the array.

        +
      • start: number

        If start is negative, it is treated as length+start. If end is negative, it +is treated as length+end.

        +
      • Optional end: number

        If not specified, length of the this object is used as its default value.

        +

      Returns ByteView<Data>

    entries

    • entries(): IterableIterator<[number, number]>

    • Returns an array of key, value pairs for every entry in the array

      +

      Returns IterableIterator<[number, number]>

    every

    • every(predicate, thisArg?): boolean

    • Determines whether all the members of an array satisfy the specified test.

      +

      Parameters

      • predicate: ((value, index, array) => unknown)

        A function that accepts up to three arguments. The every method calls +the predicate function for each element in the array until the predicate returns a value +which is coercible to the Boolean value false, or until the end of the array.

        +
          • (value, index, array): unknown

          • Parameters

            Returns unknown

      • Optional thisArg: any

        An object to which the this keyword can refer in the predicate function. +If thisArg is omitted, undefined is used as the this value.

        +

      Returns boolean

    fill

    • fill(value, start?, end?): ByteView<Data>

    • Changes all array elements from start to end index to a static value and returns the modified array

      +

      Parameters

      • value: number

        value to fill array section with

        +
      • Optional start: number

        index to start filling the array at. If start is negative, it is treated as +length+start where length is the length of the array.

        +
      • Optional end: number

        index to stop filling the array at. If end is negative, it is treated as +length+end.

        +

      Returns ByteView<Data>

    filter

    • filter(predicate, thisArg?): Uint8Array

    • Returns the elements of an array that meet the condition specified in a callback function.

      +

      Parameters

      • predicate: ((value, index, array) => any)

        A function that accepts up to three arguments. The filter method calls +the predicate function one time for each element in the array.

        +
          • (value, index, array): any

          • Parameters

            Returns any

      • Optional thisArg: any

        An object to which the this keyword can refer in the predicate function. +If thisArg is omitted, undefined is used as the this value.

        +

      Returns Uint8Array

    find

    • find(predicate, thisArg?): undefined | number

    • Returns the value of the first element in the array where predicate is true, and undefined +otherwise.

      +

      Parameters

      • predicate: ((value, index, obj) => boolean)

        find calls predicate once for each element of the array, in ascending +order, until it finds one where predicate returns true. If such an element is found, find +immediately returns that element value. Otherwise, find returns undefined.

        +
          • (value, index, obj): boolean

          • Parameters

            Returns boolean

      • Optional thisArg: any

        If provided, it will be used as the this value for each invocation of +predicate. If it is not provided, undefined is used instead.

        +

      Returns undefined | number

    findIndex

    • findIndex(predicate, thisArg?): number

    • Returns the index of the first element in the array where predicate is true, and -1 +otherwise.

      +

      Parameters

      • predicate: ((value, index, obj) => boolean)

        find calls predicate once for each element of the array, in ascending +order, until it finds one where predicate returns true. If such an element is found, +findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        +
          • (value, index, obj): boolean

          • Parameters

            Returns boolean

      • Optional thisArg: any

        If provided, it will be used as the this value for each invocation of +predicate. If it is not provided, undefined is used instead.

        +

      Returns number

    forEach

    • forEach(callbackfn, thisArg?): void

    • Performs the specified action for each element in an array.

      +

      Parameters

      • callbackfn: ((value, index, array) => void)

        A function that accepts up to three arguments. forEach calls the +callbackfn function one time for each element in the array.

        +
          • (value, index, array): void

          • Parameters

            Returns void

      • Optional thisArg: any

        An object to which the this keyword can refer in the callbackfn function. +If thisArg is omitted, undefined is used as the this value.

        +

      Returns void

    includes

    • includes(searchElement, fromIndex?): boolean

    • Determines whether an array includes a certain element, returning true or false as appropriate.

      +

      Parameters

      • searchElement: number

        The element to search for.

        +
      • Optional fromIndex: number

        The position in this array at which to begin searching for searchElement.

        +

      Returns boolean

    indexOf

    • indexOf(searchElement, fromIndex?): number

    • Returns the index of the first occurrence of a value in an array.

      +

      Parameters

      • searchElement: number

        The value to locate in the array.

        +
      • Optional fromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the + search starts at index 0.

        +

      Returns number

    join

    • join(separator?): string

    • Adds all the elements of an array separated by the specified separator string.

      +

      Parameters

      • Optional separator: string

        A string used to separate one element of an array from the next in the +resulting String. If omitted, the array elements are separated with a comma.

        +

      Returns string

    keys

    • keys(): IterableIterator<number>

    • Returns an list of keys in the array

      +

      Returns IterableIterator<number>

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a value in an array.

      +

      Parameters

      • searchElement: number

        The value to locate in the array.

        +
      • Optional fromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the +search starts at index 0.

        +

      Returns number

    map

    • map(callbackfn, thisArg?): Uint8Array

    • Calls a defined callback function on each element of an array, and returns an array that +contains the results.

      +

      Parameters

      • callbackfn: ((value, index, array) => number)

        A function that accepts up to three arguments. The map method calls the +callbackfn function one time for each element in the array.

        +
          • (value, index, array): number

          • Parameters

            Returns number

      • Optional thisArg: any

        An object to which the this keyword can refer in the callbackfn function. +If thisArg is omitted, undefined is used as the this value.

        +

      Returns Uint8Array

    reduce

    • reduce(callbackfn): number

    • Calls the specified callback function for all the elements in an array. The return value of +the callback function is the accumulated result, and is provided as an argument in the next +call to the callback function.

      +

      Parameters

      • callbackfn: ((previousValue, currentValue, currentIndex, array) => number)

        A function that accepts up to four arguments. The reduce method calls the +callbackfn function one time for each element in the array.

        +
          • (previousValue, currentValue, currentIndex, array): number

          • Parameters

            • previousValue: number
            • currentValue: number
            • currentIndex: number
            • array: Uint8Array

            Returns number

      Returns number

    • reduce(callbackfn, initialValue): number

    • Parameters

      • callbackfn: ((previousValue, currentValue, currentIndex, array) => number)
          • (previousValue, currentValue, currentIndex, array): number

          • Parameters

            • previousValue: number
            • currentValue: number
            • currentIndex: number
            • array: Uint8Array

            Returns number

      • initialValue: number

      Returns number

    • reduce<U>(callbackfn, initialValue): U

    • Calls the specified callback function for all the elements in an array. The return value of +the callback function is the accumulated result, and is provided as an argument in the next +call to the callback function.

      +

      Type Parameters

      • U

      Parameters

      • callbackfn: ((previousValue, currentValue, currentIndex, array) => U)

        A function that accepts up to four arguments. The reduce method calls the +callbackfn function one time for each element in the array.

        +
          • (previousValue, currentValue, currentIndex, array): U

          • Parameters

            • previousValue: U
            • currentValue: number
            • currentIndex: number
            • array: Uint8Array

            Returns U

      • initialValue: U

        If initialValue is specified, it is used as the initial value to start +the accumulation. The first call to the callbackfn function provides this value as an argument +instead of an array value.

        +

      Returns U

    reduceRight

    • reduceRight(callbackfn): number

    • Calls the specified callback function for all the elements in an array, in descending order. +The return value of the callback function is the accumulated result, and is provided as an +argument in the next call to the callback function.

      +

      Parameters

      • callbackfn: ((previousValue, currentValue, currentIndex, array) => number)

        A function that accepts up to four arguments. The reduceRight method calls +the callbackfn function one time for each element in the array.

        +
          • (previousValue, currentValue, currentIndex, array): number

          • Parameters

            • previousValue: number
            • currentValue: number
            • currentIndex: number
            • array: Uint8Array

            Returns number

      Returns number

    • reduceRight(callbackfn, initialValue): number

    • Parameters

      • callbackfn: ((previousValue, currentValue, currentIndex, array) => number)
          • (previousValue, currentValue, currentIndex, array): number

          • Parameters

            • previousValue: number
            • currentValue: number
            • currentIndex: number
            • array: Uint8Array

            Returns number

      • initialValue: number

      Returns number

    • reduceRight<U>(callbackfn, initialValue): U

    • Calls the specified callback function for all the elements in an array, in descending order. +The return value of the callback function is the accumulated result, and is provided as an +argument in the next call to the callback function.

      +

      Type Parameters

      • U

      Parameters

      • callbackfn: ((previousValue, currentValue, currentIndex, array) => U)

        A function that accepts up to four arguments. The reduceRight method calls +the callbackfn function one time for each element in the array.

        +
          • (previousValue, currentValue, currentIndex, array): U

          • Parameters

            • previousValue: U
            • currentValue: number
            • currentIndex: number
            • array: Uint8Array

            Returns U

      • initialValue: U

        If initialValue is specified, it is used as the initial value to start +the accumulation. The first call to the callbackfn function provides this value as an argument +instead of an array value.

        +

      Returns U

    reverse

    • reverse(): Uint8Array

    • Reverses the elements in an Array.

      +

      Returns Uint8Array

    set

    • set(array, offset?): void

    • Sets a value or an array of values.

      +

      Parameters

      • array: ArrayLike<number>

        A typed or untyped array of values to set.

        +
      • Optional offset: number

        The index in the current array at which the values are to be written.

        +

      Returns void

    slice

    • slice(start?, end?): Uint8Array

    • Returns a section of an array.

      +

      Parameters

      • Optional start: number

        The beginning of the specified portion of the array.

        +
      • Optional end: number

        The end of the specified portion of the array. This is exclusive of the element at the index 'end'.

        +

      Returns Uint8Array

    some

    • some(predicate, thisArg?): boolean

    • Determines whether the specified callback function returns true for any element of an array.

      +

      Parameters

      • predicate: ((value, index, array) => unknown)

        A function that accepts up to three arguments. The some method calls +the predicate function for each element in the array until the predicate returns a value +which is coercible to the Boolean value true, or until the end of the array.

        +
          • (value, index, array): unknown

          • Parameters

            Returns unknown

      • Optional thisArg: any

        An object to which the this keyword can refer in the predicate function. +If thisArg is omitted, undefined is used as the this value.

        +

      Returns boolean

    sort

    • sort(compareFn?): ByteView<Data>

    • Sorts an array.

      +

      Parameters

      • Optional compareFn: ((a, b) => number)

        Function used to determine the order of the elements. It is expected to return +a negative value if first argument is less than second argument, zero if they're equal and a positive +value otherwise. If omitted, the elements are sorted in ascending order.

        +
        [11,2,22,1].sort((a, b) => a - b)
+
        +
          • (a, b): number

          • Parameters

            • a: number
            • b: number

            Returns number

      Returns ByteView<Data>

    subarray

    • subarray(begin?, end?): Uint8Array

    • Gets a new Uint8Array view of the ArrayBuffer store for this array, referencing the elements +at begin, inclusive, up to end, exclusive.

      +

      Parameters

      • Optional begin: number

        The index of the beginning of the array.

        +
      • Optional end: number

        The index of the end of the array.

        +

      Returns Uint8Array

    toLocaleString

    • toLocaleString(): string

    • Converts a number to a string by using the current locale.

      +

      Returns string

    toString

    • toString(): string

    • Returns a string representation of an array.

      +

      Returns string

    valueOf

    • valueOf(): Uint8Array

    • Returns the primitive value of the specified object.

      +

      Returns Uint8Array

    values

    • values(): IterableIterator<number>

    • Returns an list of values in the array

      +

      Returns IterableIterator<number>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/block_interface.Phantom.html b/interfaces/block_interface.Phantom.html new file mode 100644 index 00000000..15f3184f --- /dev/null +++ b/interfaces/block_interface.Phantom.html @@ -0,0 +1,10 @@ +Phantom | multiformats - v12.1.3

    Interface Phantom<T>

    A utility type to retain an unused type parameter T. +Similar to phantom type parameters in Rust.

    +

    Capturing unused type parameters allows us to define "nominal types," which +TypeScript does not natively support. Nominal types in turn allow us to capture +semantics not represented in the actual type structure, without requiring us to define +new classes or pay additional runtime costs.

    +

    For a concrete example, see ByteView, which extends the Uint8Array type to capture +type information about the structure of the data encoded into the array.

    +
    interface Phantom {
        [Marker]?: T;
    }

    Type Parameters

    • T

    Hierarchy

    Properties

    [Marker]? +

    Properties

    Optional [Marker]

    [Marker]?: T

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/codecs_interface.BlockCodec.html b/interfaces/codecs_interface.BlockCodec.html new file mode 100644 index 00000000..be2858bc --- /dev/null +++ b/interfaces/codecs_interface.BlockCodec.html @@ -0,0 +1,6 @@ +BlockCodec | multiformats - v12.1.3

    Interface BlockCodec<Code, T>

    An IPLD codec is a combination of both encoder and decoder.

    +
    interface BlockCodec {
        code: Code;
        name: string;
        decode(bytes): T;
        encode(data): ByteView<T>;
    }

    Type Parameters

    • Code extends number

    • T

    Hierarchy

    Properties

    code +name +

    Methods

    decode +encode +

    Properties

    code

    code: Code

    name

    name: string

    Methods

    decode

    encode

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/index.BlockDecoder.html b/interfaces/codecs_interface.BlockDecoder.html similarity index 56% rename from interfaces/index.BlockDecoder.html rename to interfaces/codecs_interface.BlockDecoder.html index f628165c..443169e7 100644 --- a/interfaces/index.BlockDecoder.html +++ b/interfaces/codecs_interface.BlockDecoder.html @@ -1,4 +1,4 @@ -BlockDecoder | multiformats

    Interface BlockDecoder<Code, T>

    IPLD decoder part of the codec.

    -

    Type Parameters

    • Code extends number

    • T

    Hierarchy

    Properties

    code -

    Methods

    decode -

    Properties

    code

    code: Code

    Methods

    decode

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +BlockDecoder | multiformats - v12.1.3

    Interface BlockDecoder<Code, T>

    IPLD decoder part of the codec.

    +
    interface BlockDecoder {
        code: Code;
        decode(bytes): T;
    }

    Type Parameters

    • Code extends number

    • T

    Hierarchy

    Properties

    code +

    Methods

    decode +

    Properties

    code

    code: Code

    Methods

    decode

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/codecs_interface.BlockEncoder.html b/interfaces/codecs_interface.BlockEncoder.html new file mode 100644 index 00000000..c42e4682 --- /dev/null +++ b/interfaces/codecs_interface.BlockEncoder.html @@ -0,0 +1,5 @@ +BlockEncoder | multiformats - v12.1.3

    Interface BlockEncoder<Code, T>

    IPLD encoder part of the codec.

    +
    interface BlockEncoder {
        code: Code;
        name: string;
        encode(data): ByteView<T>;
    }

    Type Parameters

    • Code extends number

    • T

    Hierarchy

    Properties

    code +name +

    Methods

    encode +

    Properties

    code

    code: Code

    name

    name: string

    Methods

    encode

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/hashes_hasher.MultihashHasher.html b/interfaces/hashes_hasher.MultihashHasher.html deleted file mode 100644 index a7239d5c..00000000 --- a/interfaces/hashes_hasher.MultihashHasher.html +++ /dev/null @@ -1,12 +0,0 @@ -MultihashHasher | multiformats

    Interface MultihashHasher<Code>

    Hasher represents a hashing algorithm implementation that produces as -MultihashDigest.

    -

    Type Parameters

    • Code extends number = number

    Hierarchy

    Properties

    code -name -

    Methods

    digest -

    Properties

    code

    code: Code

    Code of the multihash

    -

    name

    name: string

    Name of the multihash

    -

    Methods

    digest

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/hashes_interface.MultihashDigest.html b/interfaces/hashes_interface.MultihashDigest.html new file mode 100644 index 00000000..2dda6454 --- /dev/null +++ b/interfaces/hashes_interface.MultihashDigest.html @@ -0,0 +1,11 @@ +MultihashDigest | multiformats - v12.1.3

    Interface MultihashDigest<Code>

    Represents a multihash digest which carries information about the +hashing algorithm and an actual hash digest.

    +
    interface MultihashDigest {
        bytes: Uint8Array;
        code: Code;
        digest: Uint8Array;
        size: number;
    }

    Type Parameters

    • Code extends number = number

    Implemented by

    Properties

    bytes +code +digest +size +

    Properties

    bytes

    bytes: Uint8Array

    Binary representation of this multihash digest.

    +

    code

    code: Code

    Code of the multihash

    +

    digest

    digest: Uint8Array

    Raw digest (without a hashing algorithm info)

    +

    size

    size: number

    byte length of the this.digest

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/hashes_interface.MultihashHasher.html b/interfaces/hashes_interface.MultihashHasher.html new file mode 100644 index 00000000..474878dd --- /dev/null +++ b/interfaces/hashes_interface.MultihashHasher.html @@ -0,0 +1,12 @@ +MultihashHasher | multiformats - v12.1.3

    Interface MultihashHasher<Code>

    Hasher represents a hashing algorithm implementation that produces as +MultihashDigest.

    +
    interface MultihashHasher {
        code: Code;
        name: string;
        digest(input): MultihashDigest<Code> | Promise<MultihashDigest<Code>>;
    }

    Type Parameters

    • Code extends number = number

    Hierarchy

    Implemented by

    Properties

    code +name +

    Methods

    digest +

    Properties

    code

    code: Code

    Code of the multihash

    +

    name

    name: string

    Name of the multihash

    +

    Methods

    digest

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/hashes_interface.SyncMultihashHasher.html b/interfaces/hashes_interface.SyncMultihashHasher.html new file mode 100644 index 00000000..2a6ea3fa --- /dev/null +++ b/interfaces/hashes_interface.SyncMultihashHasher.html @@ -0,0 +1,17 @@ +SyncMultihashHasher | multiformats - v12.1.3

    Interface SyncMultihashHasher<Code>

    Sync variant of MultihashHasher that refines return type of the digest +to MultihashDigest. It is subtype of MultihashHasher so implementations +of this interface can be passed anywhere MultihashHasher is expected, +allowing consumer to either await or check the return type to decide +whether to await or proceed with return value.

    +

    SyncMultihashHasher is useful in certain APIs where async hashing would be +impractical e.g. implementation of Hash Array Mapped Trie (HAMT).

    +
    interface SyncMultihashHasher {
        code: Code;
        name: string;
        digest(input): MultihashDigest<Code>;
    }

    Type Parameters

    • Code extends number = number

    Hierarchy

    Properties

    code +name +

    Methods

    digest +

    Properties

    code

    code: Code

    Code of the multihash

    +

    name

    name: string

    Name of the multihash

    +

    Methods

    digest

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/index.BaseCodec.html b/interfaces/index.BaseCodec.html deleted file mode 100644 index fecd3067..00000000 --- a/interfaces/index.BaseCodec.html +++ /dev/null @@ -1,4 +0,0 @@ -BaseCodec | multiformats

    Interface BaseCodec

    Base codec is just dual of encoder and decoder.

    -

    Hierarchy

    • BaseCodec

    Properties

    decoder -encoder -

    Properties

    decoder

    decoder: BaseDecoder

    encoder

    encoder: BaseEncoder

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/index.BaseDecoder.html b/interfaces/index.BaseDecoder.html deleted file mode 100644 index 775bfe23..00000000 --- a/interfaces/index.BaseDecoder.html +++ /dev/null @@ -1,5 +0,0 @@ -BaseDecoder | multiformats

    Interface BaseDecoder

    Base decoder decodes encoded with matching base encoding into bytes.

    -

    Hierarchy

    • BaseDecoder

    Methods

    baseDecode -

    Methods

    baseDecode

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/index.Block.html b/interfaces/index.Block.html deleted file mode 100644 index f45e5d6c..00000000 --- a/interfaces/index.Block.html +++ /dev/null @@ -1,9 +0,0 @@ -Block | multiformats

    Interface Block<T, C, A, V>

    Represents an IPLD block (including its CID) that can be decoded to data of -type T.

    -

    Type Parameters

    • T = unknown

      Logical type of the data encoded in the block

      -

    • C extends number = number

      multicodec code corresponding to codec used to encode the block

      -

    • A extends number = number

      multicodec code corresponding to the hashing algorithm used in CID creation.

      -

    • V extends Version = 1

      CID version

      -

    Hierarchy

    Properties

    bytes -cid -

    Properties

    bytes

    bytes: ByteView<T>

    cid

    cid: Link<T, C, A, V>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/index.BlockCodec.html b/interfaces/index.BlockCodec.html deleted file mode 100644 index 9e26d7a3..00000000 --- a/interfaces/index.BlockCodec.html +++ /dev/null @@ -1,6 +0,0 @@ -BlockCodec | multiformats

    Interface BlockCodec<Code, T>

    An IPLD codec is a combination of both encoder and decoder.

    -

    Type Parameters

    • Code extends number

    • T

    Hierarchy

    Properties

    code -name -

    Methods

    decode -encode -

    Properties

    code

    code: Code

    name

    name: string

    Methods

    decode

    encode

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/index.BlockEncoder.html b/interfaces/index.BlockEncoder.html deleted file mode 100644 index 1367b531..00000000 --- a/interfaces/index.BlockEncoder.html +++ /dev/null @@ -1,5 +0,0 @@ -BlockEncoder | multiformats

    Interface BlockEncoder<Code, T>

    IPLD encoder part of the codec.

    -

    Type Parameters

    • Code extends number

    • T

    Hierarchy

    Properties

    code -name -

    Methods

    encode -

    Properties

    code

    code: Code

    name

    name: string

    Methods

    encode

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/index.BlockView.html b/interfaces/index.BlockView.html deleted file mode 100644 index 6dbaf600..00000000 --- a/interfaces/index.BlockView.html +++ /dev/null @@ -1,13 +0,0 @@ -BlockView | multiformats

    Interface BlockView<T, C, A, V>

    Represents an IPLD block (including its CID) that can be decoded to data of -type T.

    -

    Type Parameters

    • T = unknown

      Logical type of the data encoded in the block

      -

    • C extends number = number

      multicodec code corresponding to codec used to encode the block

      -

    • A extends number = number

      multicodec code corresponding to the hashing algorithm used in CID creation.

      -

    • V extends Version = 1

      CID version

      -

    Hierarchy

    • Block<T, C, A, V>
      • BlockView

    Properties

    bytes -cid -value -

    Methods

    get -links -tree -

    Properties

    bytes

    bytes: ByteView<T>

    cid

    cid: CID<T, C, A, V>

    value

    value: T

    Methods

    get

    links

    tree

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/index.ByteView.html b/interfaces/index.ByteView.html deleted file mode 100644 index 2903d8b4..00000000 --- a/interfaces/index.ByteView.html +++ /dev/null @@ -1,166 +0,0 @@ -ByteView | multiformats

    Interface ByteView<Data>

    A byte-encoded representation of some type of Data.

    -

    A ByteView is essentially a Uint8Array that's been "tagged" with -a Data type parameter indicating the type of encoded data.

    -

    For example, a ByteView<{ hello: "world" }> is a Uint8Array containing a -binary representation of a {hello: "world"}.

    -

    Type Parameters

    • Data

    Hierarchy

    Properties

    BYTES_PER_ELEMENT -[Marker]? -[toStringTag] -buffer -byteLength -byteOffset -length -

    Methods

    [iterator] -at -copyWithin -entries -every -fill -filter -find -findIndex -forEach -includes -indexOf -join -keys -lastIndexOf -map -reduce -reduceRight -reverse -set -slice -some -sort -subarray -toLocaleString -toString -valueOf -values -

    Properties

    Readonly BYTES_PER_ELEMENT

    BYTES_PER_ELEMENT: number

    The size in bytes of each element in the array.

    -

    Optional [Marker]

    [Marker]?: Data

    Readonly [toStringTag]

    [toStringTag]: "Uint8Array"

    Readonly buffer

    buffer: ArrayBufferLike

    The ArrayBuffer instance referenced by the array.

    -

    Readonly byteLength

    byteLength: number

    The length in bytes of the array.

    -

    Readonly byteOffset

    byteOffset: number

    The offset in bytes of the array.

    -

    Readonly length

    length: number

    The length of the array.

    -

    Methods

    [iterator]

    • [iterator](): IterableIterator<number>

    • Returns IterableIterator<number>

    at

    • Returns the item located at the specified index.

      -

      Parameters

      • index: number

        The zero-based index of the desired code unit. A negative index will count back from the last item.

        -

      Returns undefined | number

    copyWithin

    • Returns the this object after copying a section of the array identified by start and end -to the same array starting at position target

      -

      Parameters

      • target: number

        If target is negative, it is treated as length+target where length is the -length of the array.

        -
      • start: number

        If start is negative, it is treated as length+start. If end is negative, it -is treated as length+end.

        -
      • Optional end: number

        If not specified, length of the this object is used as its default value.

        -

      Returns ByteView<Data>

    entries

    • Returns an array of key, value pairs for every entry in the array

      -

      Returns IterableIterator<[number, number]>

    every

    • Determines whether all the members of an array satisfy the specified test.

      -

      Parameters

      • predicate: ((value, index, array) => unknown)

        A function that accepts up to three arguments. The every method calls -the predicate function for each element in the array until the predicate returns a value -which is coercible to the Boolean value false, or until the end of the array.

        -
          • (value, index, array): unknown

          • Parameters

            Returns unknown

      • Optional thisArg: any

        An object to which the this keyword can refer in the predicate function. -If thisArg is omitted, undefined is used as the this value.

        -

      Returns boolean

    fill

    • Changes all array elements from start to end index to a static value and returns the modified array

      -

      Parameters

      • value: number

        value to fill array section with

        -
      • Optional start: number

        index to start filling the array at. If start is negative, it is treated as -length+start where length is the length of the array.

        -
      • Optional end: number

        index to stop filling the array at. If end is negative, it is treated as -length+end.

        -

      Returns ByteView<Data>

    filter

    • Returns the elements of an array that meet the condition specified in a callback function.

      -

      Parameters

      • predicate: ((value, index, array) => any)

        A function that accepts up to three arguments. The filter method calls -the predicate function one time for each element in the array.

        -
          • (value, index, array): any

          • Parameters

            Returns any

      • Optional thisArg: any

        An object to which the this keyword can refer in the predicate function. -If thisArg is omitted, undefined is used as the this value.

        -

      Returns Uint8Array

    find

    • Returns the value of the first element in the array where predicate is true, and undefined -otherwise.

      -

      Parameters

      • predicate: ((value, index, obj) => boolean)

        find calls predicate once for each element of the array, in ascending -order, until it finds one where predicate returns true. If such an element is found, find -immediately returns that element value. Otherwise, find returns undefined.

        -
          • (value, index, obj): boolean

          • Parameters

            Returns boolean

      • Optional thisArg: any

        If provided, it will be used as the this value for each invocation of -predicate. If it is not provided, undefined is used instead.

        -

      Returns undefined | number

    findIndex

    • Returns the index of the first element in the array where predicate is true, and -1 -otherwise.

      -

      Parameters

      • predicate: ((value, index, obj) => boolean)

        find calls predicate once for each element of the array, in ascending -order, until it finds one where predicate returns true. If such an element is found, -findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        -
          • (value, index, obj): boolean

          • Parameters

            Returns boolean

      • Optional thisArg: any

        If provided, it will be used as the this value for each invocation of -predicate. If it is not provided, undefined is used instead.

        -

      Returns number

    forEach

    • Performs the specified action for each element in an array.

      -

      Parameters

      • callbackfn: ((value, index, array) => void)

        A function that accepts up to three arguments. forEach calls the -callbackfn function one time for each element in the array.

        -
          • (value, index, array): void

          • Parameters

            Returns void

      • Optional thisArg: any

        An object to which the this keyword can refer in the callbackfn function. -If thisArg is omitted, undefined is used as the this value.

        -

      Returns void

    includes

    • Determines whether an array includes a certain element, returning true or false as appropriate.

      -

      Parameters

      • searchElement: number

        The element to search for.

        -
      • Optional fromIndex: number

        The position in this array at which to begin searching for searchElement.

        -

      Returns boolean

    indexOf

    • Returns the index of the first occurrence of a value in an array.

      -

      Parameters

      • searchElement: number

        The value to locate in the array.

        -
      • Optional fromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the - search starts at index 0.

        -

      Returns number

    join

    • Adds all the elements of an array separated by the specified separator string.

      -

      Parameters

      • Optional separator: string

        A string used to separate one element of an array from the next in the -resulting String. If omitted, the array elements are separated with a comma.

        -

      Returns string

    keys

    • Returns an list of keys in the array

      -

      Returns IterableIterator<number>

    lastIndexOf

    • Returns the index of the last occurrence of a value in an array.

      -

      Parameters

      • searchElement: number

        The value to locate in the array.

        -
      • Optional fromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the -search starts at index 0.

        -

      Returns number

    map

    • Calls a defined callback function on each element of an array, and returns an array that -contains the results.

      -

      Parameters

      • callbackfn: ((value, index, array) => number)

        A function that accepts up to three arguments. The map method calls the -callbackfn function one time for each element in the array.

        -
          • (value, index, array): number

          • Parameters

            Returns number

      • Optional thisArg: any

        An object to which the this keyword can refer in the callbackfn function. -If thisArg is omitted, undefined is used as the this value.

        -

      Returns Uint8Array

    reduce

    • Calls the specified callback function for all the elements in an array. The return value of -the callback function is the accumulated result, and is provided as an argument in the next -call to the callback function.

      -

      Parameters

      • callbackfn: ((previousValue, currentValue, currentIndex, array) => number)

        A function that accepts up to four arguments. The reduce method calls the -callbackfn function one time for each element in the array.

        -
          • (previousValue, currentValue, currentIndex, array): number

          • Parameters

            • previousValue: number
            • currentValue: number
            • currentIndex: number
            • array: Uint8Array

            Returns number

      Returns number

    • Parameters

      • callbackfn: ((previousValue, currentValue, currentIndex, array) => number)
          • (previousValue, currentValue, currentIndex, array): number

          • Parameters

            • previousValue: number
            • currentValue: number
            • currentIndex: number
            • array: Uint8Array

            Returns number

      • initialValue: number

      Returns number

    • Calls the specified callback function for all the elements in an array. The return value of -the callback function is the accumulated result, and is provided as an argument in the next -call to the callback function.

      -

      Type Parameters

      • U

      Parameters

      • callbackfn: ((previousValue, currentValue, currentIndex, array) => U)

        A function that accepts up to four arguments. The reduce method calls the -callbackfn function one time for each element in the array.

        -
          • (previousValue, currentValue, currentIndex, array): U

          • Parameters

            • previousValue: U
            • currentValue: number
            • currentIndex: number
            • array: Uint8Array

            Returns U

      • initialValue: U

        If initialValue is specified, it is used as the initial value to start -the accumulation. The first call to the callbackfn function provides this value as an argument -instead of an array value.

        -

      Returns U

    reduceRight

    • Calls the specified callback function for all the elements in an array, in descending order. -The return value of the callback function is the accumulated result, and is provided as an -argument in the next call to the callback function.

      -

      Parameters

      • callbackfn: ((previousValue, currentValue, currentIndex, array) => number)

        A function that accepts up to four arguments. The reduceRight method calls -the callbackfn function one time for each element in the array.

        -
          • (previousValue, currentValue, currentIndex, array): number

          • Parameters

            • previousValue: number
            • currentValue: number
            • currentIndex: number
            • array: Uint8Array

            Returns number

      Returns number

    • Parameters

      • callbackfn: ((previousValue, currentValue, currentIndex, array) => number)
          • (previousValue, currentValue, currentIndex, array): number

          • Parameters

            • previousValue: number
            • currentValue: number
            • currentIndex: number
            • array: Uint8Array

            Returns number

      • initialValue: number

      Returns number

    • Calls the specified callback function for all the elements in an array, in descending order. -The return value of the callback function is the accumulated result, and is provided as an -argument in the next call to the callback function.

      -

      Type Parameters

      • U

      Parameters

      • callbackfn: ((previousValue, currentValue, currentIndex, array) => U)

        A function that accepts up to four arguments. The reduceRight method calls -the callbackfn function one time for each element in the array.

        -
          • (previousValue, currentValue, currentIndex, array): U

          • Parameters

            • previousValue: U
            • currentValue: number
            • currentIndex: number
            • array: Uint8Array

            Returns U

      • initialValue: U

        If initialValue is specified, it is used as the initial value to start -the accumulation. The first call to the callbackfn function provides this value as an argument -instead of an array value.

        -

      Returns U

    reverse

    • Reverses the elements in an Array.

      -

      Returns Uint8Array

    set

    • Sets a value or an array of values.

      -

      Parameters

      • array: ArrayLike<number>

        A typed or untyped array of values to set.

        -
      • Optional offset: number

        The index in the current array at which the values are to be written.

        -

      Returns void

    slice

    • Returns a section of an array.

      -

      Parameters

      • Optional start: number

        The beginning of the specified portion of the array.

        -
      • Optional end: number

        The end of the specified portion of the array. This is exclusive of the element at the index 'end'.

        -

      Returns Uint8Array

    some

    • Determines whether the specified callback function returns true for any element of an array.

      -

      Parameters

      • predicate: ((value, index, array) => unknown)

        A function that accepts up to three arguments. The some method calls -the predicate function for each element in the array until the predicate returns a value -which is coercible to the Boolean value true, or until the end of the array.

        -
          • (value, index, array): unknown

          • Parameters

            Returns unknown

      • Optional thisArg: any

        An object to which the this keyword can refer in the predicate function. -If thisArg is omitted, undefined is used as the this value.

        -

      Returns boolean

    sort

    • Sorts an array.

      -

      Parameters

      • Optional compareFn: ((a, b) => number)

        Function used to determine the order of the elements. It is expected to return -a negative value if first argument is less than second argument, zero if they're equal and a positive -value otherwise. If omitted, the elements are sorted in ascending order.

        -
        [11,2,22,1].sort((a, b) => a - b)
-
        -
          • (a, b): number

          • Parameters

            • a: number
            • b: number

            Returns number

      Returns ByteView<Data>

    subarray

    • Gets a new Uint8Array view of the ArrayBuffer store for this array, referencing the elements -at begin, inclusive, up to end, exclusive.

      -

      Parameters

      • Optional begin: number

        The index of the beginning of the array.

        -
      • Optional end: number

        The index of the end of the array.

        -

      Returns Uint8Array

    toLocaleString

    • Converts a number to a string by using the current locale.

      -

      Returns string

    toString

    • Returns a string representation of an array.

      -

      Returns string

    valueOf

    • Returns the primitive value of the specified object.

      -

      Returns Uint8Array

    values

    • Returns an list of values in the array

      -

      Returns IterableIterator<number>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/index.CombobaseDecoder.html b/interfaces/index.CombobaseDecoder.html deleted file mode 100644 index f9ebea28..00000000 --- a/interfaces/index.CombobaseDecoder.html +++ /dev/null @@ -1,9 +0,0 @@ -CombobaseDecoder | multiformats

    Interface CombobaseDecoder<Prefix>

    Interface implemented by multibase decoder, that takes multibase strings -to bytes. It may support single encoding like base32 or multiple encodings -like base32, base58btc, base64. If passed multibase is incompatible it will -throw an exception.

    -

    Type Parameters

    • Prefix extends string

    Hierarchy

    Properties

    decoders -

    Methods

    decode -

    Properties

    Readonly decoders

    decoders: Record<Prefix, UnibaseDecoder<Prefix>>

    Methods

    decode

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/index.LegacyLink.html b/interfaces/index.LegacyLink.html deleted file mode 100644 index c3da7926..00000000 --- a/interfaces/index.LegacyLink.html +++ /dev/null @@ -1,16 +0,0 @@ -LegacyLink | multiformats

    Interface LegacyLink<T>

    Represents an IPLD link to a specific data of type T.

    -

    Template

    Logical type of the data being linked to.

    -

    Template

    multicodec code corresponding to a codec linked data is encoded with

    -

    Template

    multicodec code corresponding to the hashing algorithm of the CID

    -

    Type Parameters

    • T extends unknown = unknown

    Hierarchy

    Properties

    [Marker]? -byteLength -byteOffset -bytes -code -multihash -version -

    Methods

    equals -link -toString -toV1 -

    Properties

    Optional [Marker]

    [Marker]?: T

    Readonly byteLength

    byteLength: number

    Readonly byteOffset

    byteOffset: number

    Readonly bytes

    bytes: ByteView<Link<T, 112, 18, 0>>

    Readonly code

    code: 112

    Readonly multihash

    multihash: MultihashDigest<18>

    Readonly version

    version: 0

    Methods

    equals

    link

    toString

    toV1

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/index.Link.html b/interfaces/index.Link.html deleted file mode 100644 index d182627a..00000000 --- a/interfaces/index.Link.html +++ /dev/null @@ -1,17 +0,0 @@ -Link | multiformats

    Interface Link<Data, Format, Alg, V>

    Represents an IPLD link to a specific data of type T.

    -

    Template

    Logical type of the data being linked to.

    -

    Template

    multicodec code corresponding to a codec linked data is encoded with

    -

    Template

    multicodec code corresponding to the hashing algorithm of the CID

    -

    Type Parameters

    • Data extends unknown = unknown

    • Format extends number = number

    • Alg extends number = number

    • V extends Version = 1

      CID version

      -

    Hierarchy

    Properties

    [Marker]? -byteLength -byteOffset -bytes -code -multihash -version -

    Methods

    equals -link -toString -toV1 -

    Properties

    Optional [Marker]

    [Marker]?: Data

    Readonly byteLength

    byteLength: number

    Readonly byteOffset

    byteOffset: number

    Readonly bytes

    bytes: ByteView<Link<Data, Format, Alg, V>>

    Readonly code

    code: Format

    Readonly multihash

    multihash: MultihashDigest<Alg>

    Readonly version

    version: V

    Methods

    equals

    link

    toString

    toV1

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/index.LinkJSON.html b/interfaces/index.LinkJSON.html deleted file mode 100644 index 37a21fd0..00000000 --- a/interfaces/index.LinkJSON.html +++ /dev/null @@ -1,2 +0,0 @@ -LinkJSON | multiformats

    Interface LinkJSON<T>

    Type Parameters

    Hierarchy

    • LinkJSON

    Properties

    / -

    Properties

    /

    /: ToString<T, string>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/index.MultibaseCodec.html b/interfaces/index.MultibaseCodec.html deleted file mode 100644 index 2c799294..00000000 --- a/interfaces/index.MultibaseCodec.html +++ /dev/null @@ -1,6 +0,0 @@ -MultibaseCodec | multiformats

    Interface MultibaseCodec<Prefix>

    Dual of multibase encoder and decoder.

    -

    Type Parameters

    • Prefix extends string

    Hierarchy

    • MultibaseCodec

    Properties

    decoder -encoder -name -prefix -

    Properties

    decoder

    decoder: MultibaseDecoder<Prefix>

    encoder

    encoder: MultibaseEncoder<Prefix>

    name

    name: string

    prefix

    prefix: Prefix

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/index.MultibaseDecoder.html b/interfaces/index.MultibaseDecoder.html deleted file mode 100644 index 6228e3ed..00000000 --- a/interfaces/index.MultibaseDecoder.html +++ /dev/null @@ -1,8 +0,0 @@ -MultibaseDecoder | multiformats

    Interface MultibaseDecoder<Prefix>

    Interface implemented by multibase decoder, that takes multibase strings -to bytes. It may support single encoding like base32 or multiple encodings -like base32, base58btc, base64. If passed multibase is incompatible it will -throw an exception.

    -

    Type Parameters

    • Prefix extends string

    Hierarchy

    Methods

    decode -

    Methods

    decode

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/index.MultibaseEncoder.html b/interfaces/index.MultibaseEncoder.html deleted file mode 100644 index e1bba9cd..00000000 --- a/interfaces/index.MultibaseEncoder.html +++ /dev/null @@ -1,10 +0,0 @@ -MultibaseEncoder | multiformats

    Interface MultibaseEncoder<Prefix>

    Multibase encoder for the specific base encoding encodes bytes into -multibase of that encoding.

    -

    Type Parameters

    • Prefix extends string

    Hierarchy

    • MultibaseEncoder

    Properties

    name -prefix -

    Methods

    encode -

    Properties

    name

    name: string

    Name of the encoding.

    -

    prefix

    prefix: Prefix

    Prefix character for that base encoding.

    -

    Methods

    encode

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/index.Phantom.html b/interfaces/index.Phantom.html deleted file mode 100644 index 46a01cfa..00000000 --- a/interfaces/index.Phantom.html +++ /dev/null @@ -1,10 +0,0 @@ -Phantom | multiformats

    Interface Phantom<T>

    A utility type to retain an unused type parameter T. -Similar to phantom type parameters in Rust.

    -

    Capturing unused type parameters allows us to define "nominal types," which -TypeScript does not natively support. Nominal types in turn allow us to capture -semantics not represented in the actual type structure, without requiring us to define -new classes or pay additional runtime costs.

    -

    For a concrete example, see ByteView, which extends the Uint8Array type to capture -type information about the structure of the data encoded into the array.

    -

    Type Parameters

    • T

    Hierarchy

    Properties

    [Marker]? -

    Properties

    Optional [Marker]

    [Marker]?: T

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/index.SyncMultihashHasher.html b/interfaces/index.SyncMultihashHasher.html deleted file mode 100644 index 3e276068..00000000 --- a/interfaces/index.SyncMultihashHasher.html +++ /dev/null @@ -1,17 +0,0 @@ -SyncMultihashHasher | multiformats

    Interface SyncMultihashHasher<Code>

    Sync variant of MultihashHasher that refines return type of the digest -to MultihashDigest. It is subtype of MultihashHasher so implementations -of this interface can be passed anywhere MultihashHasher is expected, -allowing consumer to either await or check the return type to decide -whether to await or proceed with return value.

    -

    SyncMultihashHasher is useful in certain APIs where async hashing would be -impractical e.g. implementation of Hash Array Mapped Trie (HAMT).

    -

    Type Parameters

    • Code extends number = number

    Hierarchy

    Properties

    code -name -

    Methods

    digest -

    Properties

    code

    code: Code

    Code of the multihash

    -

    name

    name: string

    Name of the multihash

    -

    Methods

    digest

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/index.UnibaseDecoder.html b/interfaces/index.UnibaseDecoder.html deleted file mode 100644 index f37cd8d7..00000000 --- a/interfaces/index.UnibaseDecoder.html +++ /dev/null @@ -1,10 +0,0 @@ -UnibaseDecoder | multiformats

    Interface UnibaseDecoder<Prefix>

    Interface implemented by multibase decoder, that takes multibase strings -to bytes. It may support single encoding like base32 or multiple encodings -like base32, base58btc, base64. If passed multibase is incompatible it will -throw an exception.

    -

    Type Parameters

    • Prefix extends string

    Hierarchy

    Properties

    decoders? -prefix -

    Methods

    decode -

    Properties

    Optional Readonly decoders

    decoders?: null

    Readonly prefix

    prefix: Prefix

    Methods

    decode

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/link_interface.LegacyLink.html b/interfaces/link_interface.LegacyLink.html new file mode 100644 index 00000000..184f18c5 --- /dev/null +++ b/interfaces/link_interface.LegacyLink.html @@ -0,0 +1,16 @@ +LegacyLink | multiformats - v12.1.3

    Interface LegacyLink<T>

    Represents an IPLD link to a specific data of type T.

    +

    Template: T

    Logical type of the data being linked to.

    +

    Template: C

    multicodec code corresponding to a codec linked data is encoded with

    +

    Template: A

    multicodec code corresponding to the hashing algorithm of the CID

    +
    interface LegacyLink {
        [Marker]?: T;
        byteLength: number;
        byteOffset: number;
        bytes: ByteView<Link<T, 112, 18, 0>>;
        code: 112;
        multihash: MultihashDigest<18>;
        version: 0;
        equals(other): other is Link<T, 112, 18, Version>;
        link(): Link<T, 112, 18, 0>;
        toString<Prefix>(base?): ToString<Link<T, 112, 18, Version>, Prefix>;
        toV1(): Link<T, 112, 18, 1>;
    }

    Type Parameters

    • T extends unknown = unknown

    Hierarchy

    Properties

    [Marker]? +byteLength +byteOffset +bytes +code +multihash +version +

    Methods

    equals +link +toString +toV1 +

    Properties

    Optional [Marker]

    [Marker]?: T

    Readonly byteLength

    byteLength: number

    Readonly byteOffset

    byteOffset: number

    Readonly bytes

    bytes: ByteView<Link<T, 112, 18, 0>>

    Readonly code

    code: 112

    Readonly multihash

    multihash: MultihashDigest<18>

    Readonly version

    version: 0

    Methods

    equals

    link

    toString

    toV1

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/link_interface.Link.html b/interfaces/link_interface.Link.html new file mode 100644 index 00000000..f3ac66de --- /dev/null +++ b/interfaces/link_interface.Link.html @@ -0,0 +1,17 @@ +Link | multiformats - v12.1.3

    Interface Link<Data, Format, Alg, V>

    Represents an IPLD link to a specific data of type T.

    +

    Template: T

    Logical type of the data being linked to.

    +

    Template: C

    multicodec code corresponding to a codec linked data is encoded with

    +

    Template: A

    multicodec code corresponding to the hashing algorithm of the CID

    +
    interface Link {
        [Marker]?: Data;
        byteLength: number;
        byteOffset: number;
        bytes: ByteView<Link<Data, Format, Alg, V>>;
        code: Format;
        multihash: MultihashDigest<Alg>;
        version: V;
        equals(other): other is Link<Data, Format, Alg, Version>;
        link(): Link<Data, Format, Alg, V>;
        toString<Prefix>(base?): ToString<Link<Data, Format, Alg, Version>, Prefix>;
        toV1(): Link<Data, Format, Alg, 1>;
    }

    Type Parameters

    • Data extends unknown = unknown

    • Format extends number = number

    • Alg extends number = number

    • V extends Version = 1

      CID version

      +

    Hierarchy

    Implemented by

    Properties

    [Marker]? +byteLength +byteOffset +bytes +code +multihash +version +

    Methods

    equals +link +toString +toV1 +

    Properties

    Optional [Marker]

    [Marker]?: Data

    Readonly byteLength

    byteLength: number

    Readonly byteOffset

    byteOffset: number

    Readonly bytes

    bytes: ByteView<Link<Data, Format, Alg, V>>

    Readonly code

    code: Format

    Readonly multihash

    multihash: MultihashDigest<Alg>

    Readonly version

    version: V

    Methods

    equals

    link

    toString

    toV1

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/link_interface.LinkJSON.html b/interfaces/link_interface.LinkJSON.html new file mode 100644 index 00000000..5afb8471 --- /dev/null +++ b/interfaces/link_interface.LinkJSON.html @@ -0,0 +1,2 @@ +LinkJSON | multiformats - v12.1.3

    Interface LinkJSON<T>

    interface LinkJSON {
        /: ToString<T, string>;
    }

    Type Parameters

    Properties

    / +

    Properties

    /

    /: ToString<T, string>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/bases_base10.html b/modules/bases_base10.html index 9cb94109..bd7eaefe 100644 --- a/modules/bases_base10.html +++ b/modules/bases_base10.html @@ -1,2 +1,2 @@ -bases/base10 | multiformats

    Module bases/base10

    Index

    Variables

    base10 -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +bases/base10 | multiformats - v12.1.3

    Module bases/base10

    Index

    Variables

    base10 +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/bases_base16.html b/modules/bases_base16.html index f2ff0e59..49b3fa19 100644 --- a/modules/bases_base16.html +++ b/modules/bases_base16.html @@ -1,3 +1,3 @@ -bases/base16 | multiformats

    Module bases/base16

    Index

    Variables

    base16 +bases/base16 | multiformats - v12.1.3

    Module bases/base16

    Index

    Variables

    base16 base16upper -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/bases_base2.html b/modules/bases_base2.html index e54c77b8..ba9f9645 100644 --- a/modules/bases_base2.html +++ b/modules/bases_base2.html @@ -1,2 +1,2 @@ -bases/base2 | multiformats

    Module bases/base2

    Index

    Variables

    base2 -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +bases/base2 | multiformats - v12.1.3

    Module bases/base2

    Index

    Variables

    base2 +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/bases_base256emoji.html b/modules/bases_base256emoji.html index cde111d3..2dc672ea 100644 --- a/modules/bases_base256emoji.html +++ b/modules/bases_base256emoji.html @@ -1,2 +1,2 @@ -bases/base256emoji | multiformats

    Module bases/base256emoji

    Index

    Variables

    base256emoji -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +bases/base256emoji | multiformats - v12.1.3

    Module bases/base256emoji

    Index

    Variables

    base256emoji +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/bases_base32.html b/modules/bases_base32.html index 04a38b03..0f4cee0a 100644 --- a/modules/bases_base32.html +++ b/modules/bases_base32.html @@ -1,4 +1,4 @@ -bases/base32 | multiformats

    Module bases/base32

    Index

    Variables

    base32 +bases/base32 | multiformats - v12.1.3

    Module bases/base32

    Index

    Variables

    base32 base32hex base32hexpad base32hexpadupper @@ -7,4 +7,4 @@ base32padupper base32upper base32z -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/bases_base36.html b/modules/bases_base36.html index 68250740..2b845d72 100644 --- a/modules/bases_base36.html +++ b/modules/bases_base36.html @@ -1,3 +1,3 @@ -bases/base36 | multiformats

    Module bases/base36

    Index

    Variables

    base36 +bases/base36 | multiformats - v12.1.3

    Module bases/base36

    Index

    Variables

    base36 base36upper -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/bases_base58.html b/modules/bases_base58.html index 7ad83c34..c1e4cacd 100644 --- a/modules/bases_base58.html +++ b/modules/bases_base58.html @@ -1,3 +1,3 @@ -bases/base58 | multiformats

    Module bases/base58

    Index

    Variables

    base58btc +bases/base58 | multiformats - v12.1.3

    Module bases/base58

    Index

    Variables

    base58btc base58flickr -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/bases_base64.html b/modules/bases_base64.html index 0434afd9..2a1a7ce3 100644 --- a/modules/bases_base64.html +++ b/modules/bases_base64.html @@ -1,5 +1,5 @@ -bases/base64 | multiformats

    Module bases/base64

    Index

    Variables

    base64 +bases/base64 | multiformats - v12.1.3

    Module bases/base64

    Index

    Variables

    base64 base64pad base64url base64urlpad -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/bases_base8.html b/modules/bases_base8.html index e93d8f2a..d50d47b9 100644 --- a/modules/bases_base8.html +++ b/modules/bases_base8.html @@ -1,2 +1,2 @@ -bases/base8 | multiformats

    Module bases/base8

    Index

    Variables

    base8 -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +bases/base8 | multiformats - v12.1.3

    Module bases/base8

    Index

    Variables

    base8 +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/bases_identity.html b/modules/bases_identity.html index a16ef213..44fd3ba2 100644 --- a/modules/bases_identity.html +++ b/modules/bases_identity.html @@ -1,2 +1,2 @@ -bases/identity | multiformats

    Module bases/identity

    Index

    Variables

    identity -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +bases/identity | multiformats - v12.1.3

    Module bases/identity

    Index

    Variables

    identity +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/bases_interface.html b/modules/bases_interface.html new file mode 100644 index 00000000..450a7972 --- /dev/null +++ b/modules/bases_interface.html @@ -0,0 +1,10 @@ +bases/interface | multiformats - v12.1.3

    Module bases/interface

    Index

    Interfaces

    BaseCodec +BaseDecoder +BaseEncoder +CombobaseDecoder +MultibaseCodec +MultibaseDecoder +MultibaseEncoder +UnibaseDecoder +

    Type Aliases

    Multibase +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/basics.html b/modules/basics.html index 93b94dd7..40b2d4bc 100644 --- a/modules/basics.html +++ b/modules/basics.html @@ -1,4 +1,4 @@ -basics | multiformats

    Module basics

    References

    CID +basics | multiformats - v12.1.3

    Module basics

    References

    CID bytes digest hasher @@ -6,4 +6,4 @@

    Variables

    bases codecs hashes -

    References

    CID

    Re-exports CID

    bytes

    Re-exports bytes

    digest

    Renames and re-exports hashes/digest

    hasher

    Renames and re-exports hashes/hasher

    varint

    Re-exports varint

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    References

    CID

    Re-exports CID

    bytes

    Re-exports bytes

    digest

    Renames and re-exports hashes/digest

    hasher

    Renames and re-exports hashes/hasher

    varint

    Re-exports varint

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/block.html b/modules/block.html index 23644c2e..a63437c7 100644 --- a/modules/block.html +++ b/modules/block.html @@ -1,7 +1,6 @@ -block | multiformats

    Module block

    Index

    Classes

    Block -

    Interfaces

    RequiredCreateOptions +block | multiformats - v12.1.3

    Module block

    Index

    Classes

    Block

    Functions

    create createUnsafe decode encode -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/block_interface.html b/modules/block_interface.html new file mode 100644 index 00000000..1d925aff --- /dev/null +++ b/modules/block_interface.html @@ -0,0 +1,6 @@ +block/interface | multiformats - v12.1.3

    Module block/interface

    Index

    Interfaces

    Block +BlockView +ByteView +Phantom +

    Type Aliases

    BlockCursorView +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/bytes.html b/modules/bytes.html index 03a245e1..9aa1462e 100644 --- a/modules/bytes.html +++ b/modules/bytes.html @@ -1,4 +1,4 @@ -bytes | multiformats

    Module bytes

    Index

    Variables

    empty +bytes | multiformats - v12.1.3

    Module bytes

    Index

    Variables

    empty

    Functions

    coerce equals fromHex @@ -6,4 +6,4 @@ isBinary toHex toString -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/cid.html b/modules/cid.html index fecfed75..1a7aa577 100644 --- a/modules/cid.html +++ b/modules/cid.html @@ -1,4 +1,4 @@ -cid | multiformats

    Module cid

    References

    ByteView +cid | multiformats - v12.1.3

    Module cid

    References

    ByteView DAG_PB LegacyLink Link @@ -14,4 +14,4 @@

    Functions

    format fromJSON toJSON -

    References

    ByteView

    Re-exports ByteView

    DAG_PB

    Re-exports DAG_PB

    LegacyLink

    Re-exports LegacyLink

    Link

    Re-exports Link

    LinkJSON

    Re-exports LinkJSON

    MultibaseDecoder

    Re-exports MultibaseDecoder

    MultibaseEncoder

    Re-exports MultibaseEncoder

    MultihashDigest

    Re-exports MultihashDigest

    SHA_256

    Re-exports SHA_256

    ToString

    Re-exports ToString

    UnknownLink

    Re-exports UnknownLink

    Version

    Re-exports Version

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    References

    ByteView

    Re-exports ByteView

    DAG_PB

    Re-exports DAG_PB

    LegacyLink

    Re-exports LegacyLink

    Link

    Re-exports Link

    LinkJSON

    Re-exports LinkJSON

    MultibaseDecoder

    Re-exports MultibaseDecoder

    MultibaseEncoder

    Re-exports MultibaseEncoder

    MultihashDigest

    Re-exports MultihashDigest

    SHA_256

    Re-exports SHA_256

    ToString

    Re-exports ToString

    UnknownLink

    Re-exports UnknownLink

    Version

    Re-exports Version

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/codecs_interface.html b/modules/codecs_interface.html new file mode 100644 index 00000000..0044f223 --- /dev/null +++ b/modules/codecs_interface.html @@ -0,0 +1,5 @@ +codecs/interface | multiformats - v12.1.3

    Module codecs/interface

    References

    ByteView +

    Interfaces

    BlockCodec +BlockDecoder +BlockEncoder +

    References

    ByteView

    Re-exports ByteView

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/codecs_json.html b/modules/codecs_json.html index 7e009ee6..276c96fb 100644 --- a/modules/codecs_json.html +++ b/modules/codecs_json.html @@ -1,6 +1,5 @@ -codecs/json | multiformats

    Module codecs/json

    Index

    Type Aliases

    ByteView -

    Variables

    code +codecs/json | multiformats - v12.1.3

    Module codecs/json

    Index

    Variables

    code name

    Functions

    decode encode -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/codecs_raw.html b/modules/codecs_raw.html index 647d6c3f..d2ba3940 100644 --- a/modules/codecs_raw.html +++ b/modules/codecs_raw.html @@ -1,6 +1,5 @@ -codecs/raw | multiformats

    Module codecs/raw

    Index

    Type Aliases

    ByteView -

    Variables

    code +codecs/raw | multiformats - v12.1.3

    Module codecs/raw

    Index

    Variables

    code name

    Functions

    decode encode -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/hashes_digest.html b/modules/hashes_digest.html index daa72766..943ae325 100644 --- a/modules/hashes_digest.html +++ b/modules/hashes_digest.html @@ -1,6 +1,5 @@ -hashes/digest | multiformats

    Module hashes/digest

    Index

    Classes

    Digest -

    Type Aliases

    MultihashDigest +hashes/digest | multiformats - v12.1.3

    Module hashes/digest

    Index

    Classes

    Digest

    Functions

    create decode equals -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/hashes_hasher.html b/modules/hashes_hasher.html index d28d185f..77746533 100644 --- a/modules/hashes_hasher.html +++ b/modules/hashes_hasher.html @@ -1,5 +1,3 @@ -hashes/hasher | multiformats

    Module hashes/hasher

    Index

    Classes

    Hasher -

    Interfaces

    MultihashHasher -

    Type Aliases

    Await +hashes/hasher | multiformats - v12.1.3

    Module hashes/hasher

    Index

    Classes

    Hasher

    Functions

    from -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/hashes_identity.html b/modules/hashes_identity.html index 71b96b8e..64b77516 100644 --- a/modules/hashes_identity.html +++ b/modules/hashes_identity.html @@ -1,2 +1,2 @@ -hashes/identity | multiformats

    Module hashes/identity

    Index

    Variables

    identity -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +hashes/identity | multiformats - v12.1.3

    Module hashes/identity

    Index

    Variables

    identity +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/index.MultihashDigest.html b/modules/hashes_interface.html similarity index 50% rename from interfaces/index.MultihashDigest.html rename to modules/hashes_interface.html index 9bc44104..984a49f3 100644 --- a/interfaces/index.MultihashDigest.html +++ b/modules/hashes_interface.html @@ -1,11 +1,4 @@ -MultihashDigest | multiformats

    Interface MultihashDigest<Code>

    Represents a multihash digest which carries information about the -hashing algorithm and an actual hash digest.

    -

    Type Parameters

    • Code extends number = number

    Hierarchy

    • MultihashDigest

    Properties

    bytes -code -digest -size -

    Properties

    bytes

    bytes: Uint8Array

    Binary representation of this multihash digest.

    -

    code

    code: Code

    Code of the multihash

    -

    digest

    digest: Uint8Array

    Raw digest (without a hashing algorithm info)

    -

    size

    size: number

    byte length of the this.digest

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +hashes/interface | multiformats - v12.1.3

    Module hashes/interface

    Index

    Interfaces

    MultihashDigest +MultihashHasher +SyncMultihashHasher +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/hashes_sha1.html b/modules/hashes_sha1.html index 2f95cdeb..03e30a5e 100644 --- a/modules/hashes_sha1.html +++ b/modules/hashes_sha1.html @@ -1,2 +1,2 @@ -hashes/sha1 | multiformats

    Module hashes/sha1

    Index

    Variables

    sha1 -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +hashes/sha1 | multiformats - v12.1.3

    Module hashes/sha1

    Index

    Variables

    sha1 +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/hashes_sha2.html b/modules/hashes_sha2.html index cc6b5dee..5b787a65 100644 --- a/modules/hashes_sha2.html +++ b/modules/hashes_sha2.html @@ -1,3 +1,3 @@ -hashes/sha2 | multiformats

    Module hashes/sha2

    Index

    Variables

    sha256 +hashes/sha2 | multiformats - v12.1.3

    Module hashes/sha2

    Index

    Variables

    sha256 sha512 -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/index.html b/modules/index.html index e07cf441..886ee058 100644 --- a/modules/index.html +++ b/modules/index.html @@ -1,34 +1,177 @@ -index | multiformats

    Module index

    References

    CID +index | multiformats - v12.1.3

    Module index

    This library defines common interfaces and low level building blocks for various interrelated multiformat technologies (multicodec, multihash, multibase, and CID). They can be used to implement custom base encoders / decoders / codecs, codec encoders /decoders and multihash hashers that comply to the interface that layers above assume.

    +

    This library provides implementations for most basics and many others can be found in linked repositories.

    +
    import { CID } from 'multiformats/cid'
    import * as json from 'multiformats/codecs/json'
    import { sha256 } from 'multiformats/hashes/sha2'

    const bytes = json.encode({ hello: 'world' })

    const hash = await sha256.digest(bytes)
    const cid = CID.create(1, json.code, hash)
    //> CID(bagaaierasords4njcts6vs7qvdjfcvgnume4hqohf65zsfguprqphs3icwea)
+
    +

    Creating Blocks

    import * as Block from 'multiformats/block'
    import * as codec from '@ipld/dag-cbor'
    import { sha256 as hasher } from 'multiformats/hashes/sha2'

    const value = { hello: 'world' }

    // encode a block
    let block = await Block.encode({ value, codec, hasher })

    block.value // { hello: 'world' }
    block.bytes // Uint8Array
    block.cid   // CID() w/ sha2-256 hash address and dag-cbor codec

    // you can also decode blocks from their binary state
    block = await Block.decode({ bytes: block.bytes, codec, hasher })

    // if you have the cid you can also verify the hash on decode
    block = await Block.create({ bytes: block.bytes, cid: block.cid, codec, hasher })
+
    +

    Multibase Encoders / Decoders / Codecs

    CIDs can be serialized to string representation using multibase encoders that implement MultibaseEncoder interface. This library provides quite a few implementations that can be imported:

    +
    import { base64 } from "multiformats/bases/base64"
    cid.toString(base64.encoder)
    //> 'mAYAEEiCTojlxqRTl6svwqNJRVM2jCcPBxy+7mRTUfGDzy2gViA'
+
    +

    Parsing CID string serialized CIDs requires multibase decoder that implements MultibaseDecoder interface. This library provides a decoder for every encoder it provides:

    +
    CID.parse('mAYAEEiCTojlxqRTl6svwqNJRVM2jCcPBxy+7mRTUfGDzy2gViA', base64.decoder)
    //> CID(bagaaierasords4njcts6vs7qvdjfcvgnume4hqohf65zsfguprqphs3icwea)
+
    +

    Dual of multibase encoder & decoder is defined as multibase codec and it exposes +them as encoder and decoder properties. For added convenience codecs also +implement MultibaseEncoder and MultibaseDecoder interfaces so they could be +used as either or both:

    +
    cid.toString(base64)
    CID.parse(cid.toString(base64), base64)
+
    +

    Note: CID implementation comes bundled with base32 and base58btc +multibase codecs so that CIDs can be base serialized to (version specific) +default base encoding and parsed without having to supply base encoders/decoders:

    +
    const v1 = CID.parse('bagaaierasords4njcts6vs7qvdjfcvgnume4hqohf65zsfguprqphs3icwea')
    v1.toString()
    //> 'bagaaierasords4njcts6vs7qvdjfcvgnume4hqohf65zsfguprqphs3icwea'

    const v0 = CID.parse('QmdfTbBqBPQ7VNxZEYEj14VmRuZBkqFbiwReogJgS1zR1n')
    v0.toString()
    //> 'QmdfTbBqBPQ7VNxZEYEj14VmRuZBkqFbiwReogJgS1zR1n'
    v0.toV1().toString()
    //> 'bafybeihdwdcefgh4dqkjv67uzcmw7ojee6xedzdetojuzjevtenxquvyku'
+
    +

    Multicodec Encoders / Decoders / Codecs

    This library defines BlockEncoder, BlockDecoder and BlockCodec interfaces. +Codec implementations should conform to the BlockCodec interface which implements both BlockEncoder and BlockDecoder. +Here is an example implementation of JSON BlockCodec.

    +
    export const { name, code, encode, decode } = {
      name: 'json',
      code: 0x0200,
      encode: json => new TextEncoder().encode(JSON.stringify(json)),
      decode: bytes => JSON.parse(new TextDecoder().decode(bytes))
    }
+
    +

    Multihash Hashers

    This library defines MultihashHasher and MultihashDigest interfaces and convinient function for implementing them:

    +
    import * as hasher from 'multiformats/hashes/hasher'

    const sha256 = hasher.from({
      // As per multiformats table
      // https://github.com/multiformats/multicodec/blob/master/table.csv#L9
      name: 'sha2-256',
      code: 0x12,

      encode: (input) => new Uint8Array(crypto.createHash('sha256').update(input).digest())
    })

    const hash = await sha256.digest(json.encode({ hello: 'world' }))
    CID.create(1, json.code, hash)

    //> CID(bagaaierasords4njcts6vs7qvdjfcvgnume4hqohf65zsfguprqphs3icwea)
+
    +

    Traversal

    This library contains higher-order functions for traversing graphs of data easily.

    +

    walk() walks through the links in each block of a DAG calling a user-supplied loader function for each one, in depth-first order with no duplicate block visits. The loader should return a Block object and can be used to inspect and collect block ordering for a full DAG walk. The loader should throw on error, and return null if a block should be skipped by walk().

    +
    import { walk } from 'multiformats/traversal'
    import * as Block from 'multiformats/block'
    import * as codec from 'multiformats/codecs/json'
    import { sha256 as hasher } from 'multiformats/hashes/sha2'

    // build a DAG (a single block for this simple example)
    const value = { hello: 'world' }
    const block = await Block.encode({ value, codec, hasher })
    const { cid } = block
    console.log(cid)
    //> CID(bagaaierasords4njcts6vs7qvdjfcvgnume4hqohf65zsfguprqphs3icwea)

    // create a loader function that also collects CIDs of blocks in
    // their traversal order
    const load = (cid, blocks) => async (cid) => {
      // fetch a block using its cid
      // e.g.: const block = await fetchBlockByCID(cid)
      blocks.push(cid)
      return block
    }

    // collect blocks in this DAG starting from the root `cid`
    const blocks = []
    await walk({ cid, load: load(cid, blocks) })

    console.log(blocks)
    //> [CID(bagaaierasords4njcts6vs7qvdjfcvgnume4hqohf65zsfguprqphs3icwea)]
+
    +

    Legacy interface

    blockcodec-to-ipld-format converts a multiformats BlockCodec into an +interface-ipld-format for use with the ipld package. This can help bridge IPLD codecs implemented using the structure and interfaces defined here to existing code that assumes, or requires interface-ipld-format. This bridge also includes the relevant TypeScript definitions.

    +

    Implementations

    By default, no base encodings (other than base32 & base58btc), hash functions, +or codec implementations are exposed by multiformats, you need to +import the ones you need yourself.

    +

    Multibase codecs

    + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    basesimportrepo
    base16multiformats/bases/base16multiformats/js-multiformats
    base32, base32pad, base32hex, base32hexpad, base32zmultiformats/bases/base32multiformats/js-multiformats
    base64, base64pad, base64url, base64urlpadmultiformats/bases/base64multiformats/js-multiformats
    base58btc, base58flick4multiformats/bases/base58multiformats/js-multiformats
    +

    Other (less useful) bases implemented in multiformats/js-multiformats include: base2, base8, base10, base36 and base256emoji.

    +

    Multihash hashers

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    hashesimportrepo
    sha2-256, sha2-512multiformats/hashes/sha2multiformats/js-multiformats
    sha3-224, sha3-256, sha3-384,sha3-512, shake-128, shake-256, keccak-224, keccak-256, keccak-384, keccak-512@multiformats/sha3multiformats/js-sha3
    identitymultiformats/hashes/identitymultiformats/js-multiformats
    murmur3-128, murmur3-32@multiformats/murmur3multiformats/js-murmur3
    blake2b-*, blake2s-*@multiformats/blake2multiformats/js-blake2
    +

    IPLD codecs (multicodec)

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    codecimportrepo
    rawmultiformats/codecs/rawmultiformats/js-multiformats
    jsonmultiformats/codecs/jsonmultiformats/js-multiformats
    dag-cbor@ipld/dag-cboripld/js-dag-cbor
    dag-json@ipld/dag-jsonipld/js-dag-json
    dag-pb@ipld/dag-pbipld/js-dag-pb
    dag-josedag-joseceramicnetwork/js-dag-jose
    +

    References

    BaseCodec +BaseDecoder +BaseEncoder +Block +BlockCodec +BlockCursorView +BlockDecoder +BlockEncoder +BlockView +ByteView +CID +CombobaseDecoder +DAG_PB +LegacyLink +Link +LinkJSON +Multibase +MultibaseCodec +MultibaseDecoder +MultibaseEncoder +MultihashDigest MultihashHasher +Phantom +SHA_256 +SyncMultihashHasher +ToString +UnibaseDecoder +UnknownLink +Version bytes digest hasher

    Namespaces

    varint -

    Interfaces

    BaseCodec -BaseDecoder -BaseEncoder -Block -BlockCodec -BlockDecoder -BlockEncoder -BlockView -ByteView -CombobaseDecoder -LegacyLink -Link -LinkJSON -MultibaseCodec -MultibaseDecoder -MultibaseEncoder -MultihashDigest -Phantom -SyncMultihashHasher -UnibaseDecoder -

    Type Aliases

    BlockCursorView -DAG_PB -Multibase -SHA_256 -ToString -UnknownLink -Version -

    References

    CID

    Re-exports CID

    MultihashHasher

    Re-exports MultihashHasher

    bytes

    Re-exports bytes

    digest

    Renames and re-exports hashes/digest

    hasher

    Renames and re-exports hashes/hasher

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    References

    BaseCodec

    Re-exports BaseCodec

    BaseDecoder

    Re-exports BaseDecoder

    BaseEncoder

    Re-exports BaseEncoder

    Block

    Re-exports Block

    BlockCodec

    Re-exports BlockCodec

    BlockCursorView

    Re-exports BlockCursorView

    BlockDecoder

    Re-exports BlockDecoder

    BlockEncoder

    Re-exports BlockEncoder

    BlockView

    Re-exports BlockView

    ByteView

    Re-exports ByteView

    CID

    Re-exports CID

    CombobaseDecoder

    Re-exports CombobaseDecoder

    DAG_PB

    Re-exports DAG_PB

    LegacyLink

    Re-exports LegacyLink

    Link

    Re-exports Link

    LinkJSON

    Re-exports LinkJSON

    Multibase

    Re-exports Multibase

    MultibaseCodec

    Re-exports MultibaseCodec

    MultibaseDecoder

    Re-exports MultibaseDecoder

    MultibaseEncoder

    Re-exports MultibaseEncoder

    MultihashDigest

    Re-exports MultihashDigest

    MultihashHasher

    Re-exports MultihashHasher

    Phantom

    Re-exports Phantom

    SHA_256

    Re-exports SHA_256

    SyncMultihashHasher

    Re-exports SyncMultihashHasher

    ToString

    Re-exports ToString

    UnibaseDecoder

    Re-exports UnibaseDecoder

    UnknownLink

    Re-exports UnknownLink

    Version

    Re-exports Version

    bytes

    Re-exports bytes

    digest

    Renames and re-exports hashes/digest

    hasher

    Renames and re-exports hashes/hasher

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/index.varint.html b/modules/index.varint.html index edc8ccb3..5c2f60af 100644 --- a/modules/index.varint.html +++ b/modules/index.varint.html @@ -1,4 +1,4 @@ -varint | multiformats

    Namespace varint

    Index

    Functions

    decode +varint | multiformats - v12.1.3

    Namespace varint

    Index

    Functions

    decode encodeTo encodingLength -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/interface.html b/modules/interface.html new file mode 100644 index 00000000..44bfbfed --- /dev/null +++ b/modules/interface.html @@ -0,0 +1,29 @@ +interface | multiformats - v12.1.3

    Module interface

    References

    BaseCodec +BaseDecoder +BaseEncoder +Block +BlockCodec +BlockCursorView +BlockDecoder +BlockEncoder +BlockView +ByteView +CombobaseDecoder +DAG_PB +LegacyLink +Link +LinkJSON +Multibase +MultibaseCodec +MultibaseDecoder +MultibaseEncoder +MultihashDigest +MultihashHasher +Phantom +SHA_256 +SyncMultihashHasher +ToString +UnibaseDecoder +UnknownLink +Version +

    References

    BaseCodec

    Re-exports BaseCodec

    BaseDecoder

    Re-exports BaseDecoder

    BaseEncoder

    Re-exports BaseEncoder

    Block

    Re-exports Block

    BlockCodec

    Re-exports BlockCodec

    BlockCursorView

    Re-exports BlockCursorView

    BlockDecoder

    Re-exports BlockDecoder

    BlockEncoder

    Re-exports BlockEncoder

    BlockView

    Re-exports BlockView

    ByteView

    Re-exports ByteView

    CombobaseDecoder

    Re-exports CombobaseDecoder

    DAG_PB

    Re-exports DAG_PB

    LegacyLink

    Re-exports LegacyLink

    Link

    Re-exports Link

    LinkJSON

    Re-exports LinkJSON

    Multibase

    Re-exports Multibase

    MultibaseCodec

    Re-exports MultibaseCodec

    MultibaseDecoder

    Re-exports MultibaseDecoder

    MultibaseEncoder

    Re-exports MultibaseEncoder

    MultihashDigest

    Re-exports MultihashDigest

    MultihashHasher

    Re-exports MultihashHasher

    Phantom

    Re-exports Phantom

    SHA_256

    Re-exports SHA_256

    SyncMultihashHasher

    Re-exports SyncMultihashHasher

    ToString

    Re-exports ToString

    UnibaseDecoder

    Re-exports UnibaseDecoder

    UnknownLink

    Re-exports UnknownLink

    Version

    Re-exports Version

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/link.html b/modules/link.html index e6aa8452..be2dbff5 100644 --- a/modules/link.html +++ b/modules/link.html @@ -1,4 +1,4 @@ -link | multiformats

    Module link

    References

    ByteView +link | multiformats - v12.1.3

    Module link

    References

    ByteView DAG_PB LegacyLink Link @@ -18,4 +18,4 @@ decode isLink parse -

    References

    ByteView

    Re-exports ByteView

    DAG_PB

    Re-exports DAG_PB

    LegacyLink

    Re-exports LegacyLink

    Link

    Re-exports Link

    LinkJSON

    Re-exports LinkJSON

    MultibaseDecoder

    Re-exports MultibaseDecoder

    MultibaseEncoder

    Re-exports MultibaseEncoder

    MultihashDigest

    Re-exports MultihashDigest

    SHA_256

    Re-exports SHA_256

    ToString

    Re-exports ToString

    UnknownLink

    Re-exports UnknownLink

    Version

    Re-exports Version

    format

    Re-exports format

    fromJSON

    Re-exports fromJSON

    toJSON

    Re-exports toJSON

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    References

    ByteView

    Re-exports ByteView

    DAG_PB

    Re-exports DAG_PB

    LegacyLink

    Re-exports LegacyLink

    Link

    Re-exports Link

    LinkJSON

    Re-exports LinkJSON

    MultibaseDecoder

    Re-exports MultibaseDecoder

    MultibaseEncoder

    Re-exports MultibaseEncoder

    MultihashDigest

    Re-exports MultihashDigest

    SHA_256

    Re-exports SHA_256

    ToString

    Re-exports ToString

    UnknownLink

    Re-exports UnknownLink

    Version

    Re-exports Version

    format

    Re-exports format

    fromJSON

    Re-exports fromJSON

    toJSON

    Re-exports toJSON

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/link_interface.html b/modules/link_interface.html new file mode 100644 index 00000000..8ff1aa32 --- /dev/null +++ b/modules/link_interface.html @@ -0,0 +1,13 @@ +link/interface | multiformats - v12.1.3

    Module link/interface

    References

    ByteView +MultibaseDecoder +MultibaseEncoder +MultihashDigest +

    Interfaces

    LegacyLink +Link +LinkJSON +

    Type Aliases

    DAG_PB +SHA_256 +ToString +UnknownLink +Version +

    References

    ByteView

    Re-exports ByteView

    MultibaseDecoder

    Re-exports MultibaseDecoder

    MultibaseEncoder

    Re-exports MultibaseEncoder

    MultihashDigest

    Re-exports MultihashDigest

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/traversal.html b/modules/traversal.html index aadfaeae..0f9db2ba 100644 --- a/modules/traversal.html +++ b/modules/traversal.html @@ -1,4 +1,2 @@ -traversal | multiformats

    Module traversal

    Index

    Type Aliases

    BlockView -CID -

    Functions

    walk -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +traversal | multiformats - v12.1.3

    Module traversal

    Index

    Functions

    walk +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/bases_interface.Multibase.html b/types/bases_interface.Multibase.html new file mode 100644 index 00000000..8edf587b --- /dev/null +++ b/types/bases_interface.Multibase.html @@ -0,0 +1,3 @@ +Multibase | multiformats - v12.1.3

    Type alias Multibase<Prefix>

    Multibase<Prefix>: string | string & {
        0: Prefix;
    }

    Multibase represents base encoded strings with a prefix first character +describing it's encoding.

    +

    Type Parameters

    • Prefix extends string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/block_interface.BlockCursorView.html b/types/block_interface.BlockCursorView.html new file mode 100644 index 00000000..917b642a --- /dev/null +++ b/types/block_interface.BlockCursorView.html @@ -0,0 +1 @@ +BlockCursorView | multiformats - v12.1.3

    Type alias BlockCursorView<T>

    BlockCursorView<T>: {
        remaining?: undefined;
        value: T;
    } | {
        remaining: string;
        value: CID;
    }

    Type Parameters

    • T = unknown

    Type declaration

    • Optional remaining?: undefined
    • value: T

    Type declaration

    • remaining: string
    • value: CID

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/codecs_json.ByteView.html b/types/codecs_json.ByteView.html deleted file mode 100644 index 86cd2e1b..00000000 --- a/types/codecs_json.ByteView.html +++ /dev/null @@ -1 +0,0 @@ -ByteView | multiformats

    Type alias ByteView<T>

    ByteView<T>: ByteView

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/codecs_raw.ByteView.html b/types/codecs_raw.ByteView.html deleted file mode 100644 index 3dd2c778..00000000 --- a/types/codecs_raw.ByteView.html +++ /dev/null @@ -1 +0,0 @@ -ByteView | multiformats

    Type alias ByteView<T>

    ByteView<T>: ByteView

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/hashes_digest.MultihashDigest.html b/types/hashes_digest.MultihashDigest.html deleted file mode 100644 index 303bb118..00000000 --- a/types/hashes_digest.MultihashDigest.html +++ /dev/null @@ -1 +0,0 @@ -MultihashDigest | multiformats

    Type alias MultihashDigest

    MultihashDigest: MultihashDigest

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/hashes_hasher.Await.html b/types/hashes_hasher.Await.html deleted file mode 100644 index 8c307231..00000000 --- a/types/hashes_hasher.Await.html +++ /dev/null @@ -1 +0,0 @@ -Await | multiformats

    Type alias Await<T>

    Await<T>: Promise<T> | T

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/index.BlockCursorView.html b/types/index.BlockCursorView.html deleted file mode 100644 index bb01b462..00000000 --- a/types/index.BlockCursorView.html +++ /dev/null @@ -1 +0,0 @@ -BlockCursorView | multiformats

    Type alias BlockCursorView<T>

    BlockCursorView<T>: {
        remaining?: undefined;
        value: T;
    } | {
        remaining: string;
        value: CID;
    }

    Type Parameters

    • T extends unknown = unknown

    Type declaration

    • Optional remaining?: undefined
    • value: T

    Type declaration

    • remaining: string
    • value: CID

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/index.DAG_PB.html b/types/index.DAG_PB.html deleted file mode 100644 index 8c098340..00000000 --- a/types/index.DAG_PB.html +++ /dev/null @@ -1 +0,0 @@ -DAG_PB | multiformats

    Type alias DAG_PB

    DAG_PB: 112

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/index.Multibase.html b/types/index.Multibase.html deleted file mode 100644 index 37a47a20..00000000 --- a/types/index.Multibase.html +++ /dev/null @@ -1,3 +0,0 @@ -Multibase | multiformats

    Type alias Multibase<Prefix>

    Multibase<Prefix>: string | string & {
        0: Prefix;
    }

    Multibase represents base encoded strings with a prefix first character -describing it's encoding.

    -

    Type Parameters

    • Prefix extends string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/index.SHA_256.html b/types/index.SHA_256.html deleted file mode 100644 index cfd9f015..00000000 --- a/types/index.SHA_256.html +++ /dev/null @@ -1 +0,0 @@ -SHA_256 | multiformats

    Type alias SHA_256

    SHA_256: 18

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/index.ToString.html b/types/index.ToString.html deleted file mode 100644 index 30545716..00000000 --- a/types/index.ToString.html +++ /dev/null @@ -1 +0,0 @@ -ToString | multiformats

    Type alias ToString<T, Prefix>

    ToString<T, Prefix>: Multibase<Prefix> & Phantom<T>

    Type Parameters

    • T

    • Prefix extends string = string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/index.UnknownLink.html b/types/index.UnknownLink.html deleted file mode 100644 index 2ceb8698..00000000 --- a/types/index.UnknownLink.html +++ /dev/null @@ -1 +0,0 @@ -UnknownLink | multiformats

    Type alias UnknownLink

    UnknownLink: LegacyLink<unknown> | Link<unknown, number, number, Version>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/index.Version.html b/types/index.Version.html deleted file mode 100644 index f8c8295c..00000000 --- a/types/index.Version.html +++ /dev/null @@ -1 +0,0 @@ -Version | multiformats

    Type alias Version

    Version: 0 | 1

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/link_interface.DAG_PB.html b/types/link_interface.DAG_PB.html new file mode 100644 index 00000000..3b1d91ef --- /dev/null +++ b/types/link_interface.DAG_PB.html @@ -0,0 +1 @@ +DAG_PB | multiformats - v12.1.3

    Type alias DAG_PB

    DAG_PB: 112

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/link_interface.SHA_256.html b/types/link_interface.SHA_256.html new file mode 100644 index 00000000..611052c9 --- /dev/null +++ b/types/link_interface.SHA_256.html @@ -0,0 +1 @@ +SHA_256 | multiformats - v12.1.3

    Type alias SHA_256

    SHA_256: 18

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/link_interface.ToString.html b/types/link_interface.ToString.html new file mode 100644 index 00000000..87bcd40e --- /dev/null +++ b/types/link_interface.ToString.html @@ -0,0 +1 @@ +ToString | multiformats - v12.1.3

    Type alias ToString<T, Prefix>

    ToString<T, Prefix>: Multibase<Prefix> & Phantom<T>

    Type Parameters

    • T

    • Prefix extends string = string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/link_interface.UnknownLink.html b/types/link_interface.UnknownLink.html new file mode 100644 index 00000000..1bcc1f0b --- /dev/null +++ b/types/link_interface.UnknownLink.html @@ -0,0 +1 @@ +UnknownLink | multiformats - v12.1.3

    Type alias UnknownLink

    UnknownLink: LegacyLink<unknown> | Link<unknown, number, number, Version>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/link_interface.Version.html b/types/link_interface.Version.html new file mode 100644 index 00000000..0c5e41cd --- /dev/null +++ b/types/link_interface.Version.html @@ -0,0 +1 @@ +Version | multiformats - v12.1.3

    Type alias Version

    Version: 0 | 1

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/traversal.BlockView.html b/types/traversal.BlockView.html deleted file mode 100644 index 0113317d..00000000 --- a/types/traversal.BlockView.html +++ /dev/null @@ -1 +0,0 @@ -BlockView | multiformats

    Type alias BlockView

    BlockView: BlockView

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/traversal.CID.html b/types/traversal.CID.html deleted file mode 100644 index c4ff8d60..00000000 --- a/types/traversal.CID.html +++ /dev/null @@ -1 +0,0 @@ -CID | multiformats

    Type alias CID

    CID: cid

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/bases_base10.base10.html b/variables/bases_base10.base10.html index 3eb462f2..1d6bcdba 100644 --- a/variables/bases_base10.base10.html +++ b/variables/bases_base10.base10.html @@ -1 +1 @@ -base10 | multiformats

    Variable base10Const

    base10: Codec<"base10", "9"> = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +base10 | multiformats - v12.1.3

    Variable base10Const

    base10: Codec<"base10", "9"> = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/bases_base16.base16.html b/variables/bases_base16.base16.html index 646e291b..14a6ee4f 100644 --- a/variables/bases_base16.base16.html +++ b/variables/bases_base16.base16.html @@ -1 +1 @@ -base16 | multiformats

    Variable base16Const

    base16: Codec<"base16", "f"> = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +base16 | multiformats - v12.1.3

    Variable base16Const

    base16: Codec<"base16", "f"> = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/bases_base16.base16upper.html b/variables/bases_base16.base16upper.html index fdd76dd2..48880cb9 100644 --- a/variables/bases_base16.base16upper.html +++ b/variables/bases_base16.base16upper.html @@ -1 +1 @@ -base16upper | multiformats

    Variable base16upperConst

    base16upper: Codec<"base16upper", "F"> = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +base16upper | multiformats - v12.1.3

    Variable base16upperConst

    base16upper: Codec<"base16upper", "F"> = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/bases_base2.base2.html b/variables/bases_base2.base2.html index bd00790b..ab711997 100644 --- a/variables/bases_base2.base2.html +++ b/variables/bases_base2.base2.html @@ -1 +1 @@ -base2 | multiformats

    Variable base2Const

    base2: Codec<"base2", "0"> = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +base2 | multiformats - v12.1.3

    Variable base2Const

    base2: Codec<"base2", "0"> = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/bases_base256emoji.base256emoji.html b/variables/bases_base256emoji.base256emoji.html index 2b090ba9..1e2bf592 100644 --- a/variables/bases_base256emoji.base256emoji.html +++ b/variables/bases_base256emoji.base256emoji.html @@ -1 +1 @@ -base256emoji | multiformats

    Variable base256emojiConst

    base256emoji: Codec<"base256emoji", "🚀"> = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +base256emoji | multiformats - v12.1.3

    Variable base256emojiConst

    base256emoji: Codec<"base256emoji", "🚀"> = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/bases_base32.base32.html b/variables/bases_base32.base32.html index db7d57de..797fdd95 100644 --- a/variables/bases_base32.base32.html +++ b/variables/bases_base32.base32.html @@ -1 +1 @@ -base32 | multiformats

    Variable base32Const

    base32: Codec<"base32", "b"> = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +base32 | multiformats - v12.1.3

    Variable base32Const

    base32: Codec<"base32", "b"> = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/bases_base32.base32hex.html b/variables/bases_base32.base32hex.html index ac9c5cbb..3c16ab78 100644 --- a/variables/bases_base32.base32hex.html +++ b/variables/bases_base32.base32hex.html @@ -1 +1 @@ -base32hex | multiformats

    Variable base32hexConst

    base32hex: Codec<"base32hex", "v"> = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +base32hex | multiformats - v12.1.3

    Variable base32hexConst

    base32hex: Codec<"base32hex", "v"> = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/bases_base32.base32hexpad.html b/variables/bases_base32.base32hexpad.html index e3ec39f8..517f98f4 100644 --- a/variables/bases_base32.base32hexpad.html +++ b/variables/bases_base32.base32hexpad.html @@ -1 +1 @@ -base32hexpad | multiformats

    Variable base32hexpadConst

    base32hexpad: Codec<"base32hexpad", "t"> = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +base32hexpad | multiformats - v12.1.3

    Variable base32hexpadConst

    base32hexpad: Codec<"base32hexpad", "t"> = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/bases_base32.base32hexpadupper.html b/variables/bases_base32.base32hexpadupper.html index 81315d14..75dac9eb 100644 --- a/variables/bases_base32.base32hexpadupper.html +++ b/variables/bases_base32.base32hexpadupper.html @@ -1 +1 @@ -base32hexpadupper | multiformats

    Variable base32hexpadupperConst

    base32hexpadupper: Codec<"base32hexpadupper", "T"> = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +base32hexpadupper | multiformats - v12.1.3

    Variable base32hexpadupperConst

    base32hexpadupper: Codec<"base32hexpadupper", "T"> = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/bases_base32.base32hexupper.html b/variables/bases_base32.base32hexupper.html index 67f82ef3..719aeb60 100644 --- a/variables/bases_base32.base32hexupper.html +++ b/variables/bases_base32.base32hexupper.html @@ -1 +1 @@ -base32hexupper | multiformats

    Variable base32hexupperConst

    base32hexupper: Codec<"base32hexupper", "V"> = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +base32hexupper | multiformats - v12.1.3

    Variable base32hexupperConst

    base32hexupper: Codec<"base32hexupper", "V"> = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/bases_base32.base32pad.html b/variables/bases_base32.base32pad.html index 20e510ea..5920140b 100644 --- a/variables/bases_base32.base32pad.html +++ b/variables/bases_base32.base32pad.html @@ -1 +1 @@ -base32pad | multiformats

    Variable base32padConst

    base32pad: Codec<"base32pad", "c"> = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +base32pad | multiformats - v12.1.3

    Variable base32padConst

    base32pad: Codec<"base32pad", "c"> = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/bases_base32.base32padupper.html b/variables/bases_base32.base32padupper.html index fadac0fc..d67d3b79 100644 --- a/variables/bases_base32.base32padupper.html +++ b/variables/bases_base32.base32padupper.html @@ -1 +1 @@ -base32padupper | multiformats

    Variable base32padupperConst

    base32padupper: Codec<"base32padupper", "C"> = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +base32padupper | multiformats - v12.1.3

    Variable base32padupperConst

    base32padupper: Codec<"base32padupper", "C"> = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/bases_base32.base32upper.html b/variables/bases_base32.base32upper.html index cb89d778..5cae1dc9 100644 --- a/variables/bases_base32.base32upper.html +++ b/variables/bases_base32.base32upper.html @@ -1 +1 @@ -base32upper | multiformats

    Variable base32upperConst

    base32upper: Codec<"base32upper", "B"> = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +base32upper | multiformats - v12.1.3

    Variable base32upperConst

    base32upper: Codec<"base32upper", "B"> = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/bases_base32.base32z.html b/variables/bases_base32.base32z.html index 75f0db6c..cbf4ac3e 100644 --- a/variables/bases_base32.base32z.html +++ b/variables/bases_base32.base32z.html @@ -1 +1 @@ -base32z | multiformats

    Variable base32zConst

    base32z: Codec<"base32z", "h"> = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +base32z | multiformats - v12.1.3

    Variable base32zConst

    base32z: Codec<"base32z", "h"> = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/bases_base36.base36.html b/variables/bases_base36.base36.html index 401e3f49..afe87fc2 100644 --- a/variables/bases_base36.base36.html +++ b/variables/bases_base36.base36.html @@ -1 +1 @@ -base36 | multiformats

    Variable base36Const

    base36: Codec<"base36", "k"> = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +base36 | multiformats - v12.1.3

    Variable base36Const

    base36: Codec<"base36", "k"> = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/bases_base36.base36upper.html b/variables/bases_base36.base36upper.html index 6d815dca..21b5d7eb 100644 --- a/variables/bases_base36.base36upper.html +++ b/variables/bases_base36.base36upper.html @@ -1 +1 @@ -base36upper | multiformats

    Variable base36upperConst

    base36upper: Codec<"base36upper", "K"> = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +base36upper | multiformats - v12.1.3

    Variable base36upperConst

    base36upper: Codec<"base36upper", "K"> = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/bases_base58.base58btc.html b/variables/bases_base58.base58btc.html index cc693c4d..924e98d2 100644 --- a/variables/bases_base58.base58btc.html +++ b/variables/bases_base58.base58btc.html @@ -1 +1 @@ -base58btc | multiformats

    Variable base58btcConst

    base58btc: Codec<"base58btc", "z"> = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +base58btc | multiformats - v12.1.3

    Variable base58btcConst

    base58btc: Codec<"base58btc", "z"> = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/bases_base58.base58flickr.html b/variables/bases_base58.base58flickr.html index 8e8b6fe7..7f5419e8 100644 --- a/variables/bases_base58.base58flickr.html +++ b/variables/bases_base58.base58flickr.html @@ -1 +1 @@ -base58flickr | multiformats

    Variable base58flickrConst

    base58flickr: Codec<"base58flickr", "Z"> = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +base58flickr | multiformats - v12.1.3

    Variable base58flickrConst

    base58flickr: Codec<"base58flickr", "Z"> = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/bases_base64.base64.html b/variables/bases_base64.base64.html index 8b2c2609..ff2ad0c2 100644 --- a/variables/bases_base64.base64.html +++ b/variables/bases_base64.base64.html @@ -1 +1 @@ -base64 | multiformats

    Variable base64Const

    base64: Codec<"base64", "m"> = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +base64 | multiformats - v12.1.3

    Variable base64Const

    base64: Codec<"base64", "m"> = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/bases_base64.base64pad.html b/variables/bases_base64.base64pad.html index 90519800..698fc1ec 100644 --- a/variables/bases_base64.base64pad.html +++ b/variables/bases_base64.base64pad.html @@ -1 +1 @@ -base64pad | multiformats

    Variable base64padConst

    base64pad: Codec<"base64pad", "M"> = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +base64pad | multiformats - v12.1.3

    Variable base64padConst

    base64pad: Codec<"base64pad", "M"> = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/bases_base64.base64url.html b/variables/bases_base64.base64url.html index 6ec10b05..f13c2e2a 100644 --- a/variables/bases_base64.base64url.html +++ b/variables/bases_base64.base64url.html @@ -1 +1 @@ -base64url | multiformats

    Variable base64urlConst

    base64url: Codec<"base64url", "u"> = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +base64url | multiformats - v12.1.3

    Variable base64urlConst

    base64url: Codec<"base64url", "u"> = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/bases_base64.base64urlpad.html b/variables/bases_base64.base64urlpad.html index 95c605ac..f565c9fc 100644 --- a/variables/bases_base64.base64urlpad.html +++ b/variables/bases_base64.base64urlpad.html @@ -1 +1 @@ -base64urlpad | multiformats

    Variable base64urlpadConst

    base64urlpad: Codec<"base64urlpad", "U"> = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +base64urlpad | multiformats - v12.1.3

    Variable base64urlpadConst

    base64urlpad: Codec<"base64urlpad", "U"> = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/bases_base8.base8.html b/variables/bases_base8.base8.html index 3d1f9db8..559755ab 100644 --- a/variables/bases_base8.base8.html +++ b/variables/bases_base8.base8.html @@ -1 +1 @@ -base8 | multiformats

    Variable base8Const

    base8: Codec<"base8", "7"> = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +base8 | multiformats - v12.1.3

    Variable base8Const

    base8: Codec<"base8", "7"> = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/bases_identity.identity.html b/variables/bases_identity.identity.html index e3982a3d..6819ef5a 100644 --- a/variables/bases_identity.identity.html +++ b/variables/bases_identity.identity.html @@ -1 +1 @@ -identity | multiformats

    Variable identityConst

    identity: Codec<"identity", "\u0000"> = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +identity | multiformats - v12.1.3

    Variable identityConst

    identity: Codec<"identity", "\u0000"> = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/basics.bases.html b/variables/basics.bases.html index 21aa11b3..e990d57b 100644 --- a/variables/basics.bases.html +++ b/variables/basics.bases.html @@ -1 +1 @@ -bases | multiformats

    Variable basesConst

    bases: {
        base10: any;
        base16: any;
        base16upper: any;
        base2: any;
        base256emoji: any;
        base32: any;
        base32hex: any;
        base32hexpad: any;
        base32hexpadupper: any;
        base32hexupper: any;
        base32pad: any;
        base32padupper: any;
        base32upper: any;
        base32z: any;
        base36: any;
        base36upper: any;
        base58btc: any;
        base58flickr: any;
        base64: any;
        base64pad: any;
        base64url: any;
        base64urlpad: any;
        base8: any;
        identity: any;
    } = ...

    Type declaration

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file +bases | multiformats - v12.1.3

      Variable basesConst

      bases: {
          base10: Codec<"base10", "9">;
          base16: Codec<"base16", "f">;
          base16upper: Codec<"base16upper", "F">;
          base2: Codec<"base2", "0">;
          base256emoji: Codec<"base256emoji", "🚀">;
          base32: Codec<"base32", "b">;
          base32hex: Codec<"base32hex", "v">;
          base32hexpad: Codec<"base32hexpad", "t">;
          base32hexpadupper: Codec<"base32hexpadupper", "T">;
          base32hexupper: Codec<"base32hexupper", "V">;
          base32pad: Codec<"base32pad", "c">;
          base32padupper: Codec<"base32padupper", "C">;
          base32upper: Codec<"base32upper", "B">;
          base32z: Codec<"base32z", "h">;
          base36: Codec<"base36", "k">;
          base36upper: Codec<"base36upper", "K">;
          base58btc: Codec<"base58btc", "z">;
          base58flickr: Codec<"base58flickr", "Z">;
          base64: Codec<"base64", "m">;
          base64pad: Codec<"base64pad", "M">;
          base64url: Codec<"base64url", "u">;
          base64urlpad: Codec<"base64urlpad", "U">;
          base8: Codec<"base8", "7">;
          identity: Codec<"identity", "\u0000">;
      } = ...

      Type declaration

      • base10: Codec<"base10", "9">
      • base16: Codec<"base16", "f">
      • base16upper: Codec<"base16upper", "F">
      • base2: Codec<"base2", "0">
      • base256emoji: Codec<"base256emoji", "🚀">
      • base32: Codec<"base32", "b">
      • base32hex: Codec<"base32hex", "v">
      • base32hexpad: Codec<"base32hexpad", "t">
      • base32hexpadupper: Codec<"base32hexpadupper", "T">
      • base32hexupper: Codec<"base32hexupper", "V">
      • base32pad: Codec<"base32pad", "c">
      • base32padupper: Codec<"base32padupper", "C">
      • base32upper: Codec<"base32upper", "B">
      • base32z: Codec<"base32z", "h">
      • base36: Codec<"base36", "k">
      • base36upper: Codec<"base36upper", "K">
      • base58btc: Codec<"base58btc", "z">
      • base58flickr: Codec<"base58flickr", "Z">
      • base64: Codec<"base64", "m">
      • base64pad: Codec<"base64pad", "M">
      • base64url: Codec<"base64url", "u">
      • base64urlpad: Codec<"base64urlpad", "U">
      • base8: Codec<"base8", "7">
      • identity: Codec<"identity", "\u0000">

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/variables/basics.codecs.html b/variables/basics.codecs.html index 709a91d2..e700b7f9 100644 --- a/variables/basics.codecs.html +++ b/variables/basics.codecs.html @@ -1 +1 @@ -codecs | multiformats

      Variable codecsConst

      codecs: {
          json: codecs/json;
          raw: codecs/raw;
      } = ...

      Type declaration

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file +codecs | multiformats - v12.1.3

      Variable codecsConst

      codecs: {
          json: codecs/json;
          raw: codecs/raw;
      } = ...

      Type declaration

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/variables/basics.hashes.html b/variables/basics.hashes.html index 42051397..1bb4fa84 100644 --- a/variables/basics.hashes.html +++ b/variables/basics.hashes.html @@ -1 +1 @@ -hashes | multiformats

      Variable hashesConst

      hashes: {
          identity: {
              code: number;
              digest: ((input) => Digest<0, number>);
              encode: ((input) => Uint8Array);
              name: string;
          };
          sha256: Hasher<"sha2-256", 18>;
          sha512: Hasher<"sha2-512", 19>;
      } = ...

      Type declaration

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file +hashes | multiformats - v12.1.3

      Variable hashesConst

      hashes: {
          identity: {
              code: number;
              digest: ((input) => Digest<typeof code, number>);
              encode: ((input) => Uint8Array);
              name: string;
          };
          sha256: Hasher<"sha2-256", 18>;
          sha512: Hasher<"sha2-512", 19>;
      } = ...

      Type declaration

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/variables/bytes.empty.html b/variables/bytes.empty.html index 9449bd56..3466c382 100644 --- a/variables/bytes.empty.html +++ b/variables/bytes.empty.html @@ -1 +1 @@ -empty | multiformats

      Variable emptyConst

      empty: Uint8Array = ...

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file +empty | multiformats - v12.1.3

      Variable emptyConst

      empty: Uint8Array = ...

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/variables/codecs_json.code.html b/variables/codecs_json.code.html index a2635bc5..bb300e81 100644 --- a/variables/codecs_json.code.html +++ b/variables/codecs_json.code.html @@ -1 +1 @@ -code | multiformats

      Variable codeConst

      code: 512 = 0x0200

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file +code | multiformats - v12.1.3

      Variable codeConst

      code: 512 = 0x0200

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/variables/codecs_json.name.html b/variables/codecs_json.name.html index c291c2a8..1b7cc3af 100644 --- a/variables/codecs_json.name.html +++ b/variables/codecs_json.name.html @@ -1 +1 @@ -name | multiformats

      Variable nameConst

      name: "json" = 'json'

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file +name | multiformats - v12.1.3

      Variable nameConst

      name: "json" = 'json'

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/variables/codecs_raw.code.html b/variables/codecs_raw.code.html index 3cd211b7..d4212097 100644 --- a/variables/codecs_raw.code.html +++ b/variables/codecs_raw.code.html @@ -1 +1 @@ -code | multiformats

      Variable codeConst

      code: 85 = 0x55

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file +code | multiformats - v12.1.3

      Variable codeConst

      code: 85 = 0x55

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/variables/codecs_raw.name.html b/variables/codecs_raw.name.html index a40f23a5..90f95c00 100644 --- a/variables/codecs_raw.name.html +++ b/variables/codecs_raw.name.html @@ -1 +1 @@ -name | multiformats

      Variable nameConst

      name: "raw" = 'raw'

      Template

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file +name | multiformats - v12.1.3

      Variable nameConst

      name: "raw" = 'raw'

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/variables/hashes_identity.identity.html b/variables/hashes_identity.identity.html index d1e35b89..96ad5efe 100644 --- a/variables/hashes_identity.identity.html +++ b/variables/hashes_identity.identity.html @@ -1 +1 @@ -identity | multiformats

      Variable identityConst

      identity: {
          code: number;
          digest: ((input) => Digest<0, number>);
          encode: ((input) => Uint8Array);
          name: string;
      } = ...

      Type declaration

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file +identity | multiformats - v12.1.3

      Variable identityConst

      identity: {
          code: number;
          digest: ((input) => Digest<typeof code, number>);
          encode: ((input) => Uint8Array);
          name: string;
      } = ...

      Type declaration

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/variables/hashes_sha1.sha1.html b/variables/hashes_sha1.sha1.html index 35a6533a..dfd5112e 100644 --- a/variables/hashes_sha1.sha1.html +++ b/variables/hashes_sha1.sha1.html @@ -1 +1 @@ -sha1 | multiformats

      Variable sha1Const

      sha1: Hasher<"sha-1", 17> = ...

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file +sha1 | multiformats - v12.1.3

      Variable sha1Const

      sha1: Hasher<"sha-1", 17> = ...

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/variables/hashes_sha2.sha256.html b/variables/hashes_sha2.sha256.html index 5265e3c2..58e4cb3c 100644 --- a/variables/hashes_sha2.sha256.html +++ b/variables/hashes_sha2.sha256.html @@ -1 +1 @@ -sha256 | multiformats

      Variable sha256Const

      sha256: Hasher<"sha2-256", 18> = ...

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file +sha256 | multiformats - v12.1.3

      Variable sha256Const

      sha256: Hasher<"sha2-256", 18> = ...

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/variables/hashes_sha2.sha512.html b/variables/hashes_sha2.sha512.html index 5d15aee8..b05b72fc 100644 --- a/variables/hashes_sha2.sha512.html +++ b/variables/hashes_sha2.sha512.html @@ -1 +1 @@ -sha512 | multiformats

      Variable sha512Const

      sha512: Hasher<"sha2-512", 19> = ...

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file +sha512 | multiformats - v12.1.3

      Variable sha512Const

      sha512: Hasher<"sha2-512", 19> = ...

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file