├── examples
    ├── README.md
    ├── src
    │   ├── react-app-env.d.ts
    │   ├── setupTests.ts
    │   ├── App.test.tsx
    │   ├── index.tsx
    │   ├── index.css
    │   ├── App.css
    │   ├── App.tsx
    │   └── logo.svg
    ├── public
    │   ├── favicon.ico
    │   ├── logo192.png
    │   ├── logo512.png
    │   ├── robots.txt
    │   ├── manifest.json
    │   └── index.html
    ├── tsconfig.paths.json
    ├── config-overrides.js
    ├── .gitignore
    ├── tsconfig.json
    └── package.json
├── src
    ├── context
    │   ├── index.ts
    │   └── ipfs.tsx
    ├── types
    │   ├── index.ts
    │   └── IPFSContext.ts
    ├── classes
    │   ├── index.tsx
    │   ├── FileData.ts
    │   └── Decorator.ts
    ├── functions
    │   ├── index.ts
    │   ├── getExtension.ts
    │   └── getMime.ts
    ├── hooks
    │   ├── index.tsx
    │   ├── useIPFS.tsx
    │   ├── useStartIPFS.tsx
    │   └── useIPFSFolderState.ts
    └── index.ts
├── .gitignore
├── .eslintignore
├── doc
    ├── assets
    │   ├── icons.png
    │   ├── widgets.png
    │   ├── icons@2x.png
    │   ├── widgets@2x.png
    │   ├── highlight.css
    │   ├── search.js
    │   ├── style.css
    │   └── icons.css
    ├── modules.html
    ├── modules
    │   ├── classes.html
    │   ├── functions.html
    │   ├── hooks.html
    │   ├── types.html
    │   └── context.html
    ├── index.html
    └── classes
    │   ├── classes.IPFSDecorator.html
    │   └── classes.IPFSFileData.html
├── test
    └── blah.test.tsx
├── .eslintrc
├── rollup.config.js
├── tsdoc.json
├── .github
    └── ISSUE_TEMPLATE
    │   ├── feature_request.md
    │   └── bug_report.md
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── tsconfig.json
├── package.json
└── CODE_OF_CONDUCT.md


/examples/README.md:
--------------------------------------------------------------------------------
1 | 


--------------------------------------------------------------------------------
/src/context/index.ts:
--------------------------------------------------------------------------------
1 | export * from "./ipfs"


--------------------------------------------------------------------------------
/src/types/index.ts:
--------------------------------------------------------------------------------
1 | export * from "./IPFSContext"


--------------------------------------------------------------------------------
/examples/src/react-app-env.d.ts:
--------------------------------------------------------------------------------
1 | /// <reference types="react-scripts" />
2 | 


--------------------------------------------------------------------------------
/src/classes/index.tsx:
--------------------------------------------------------------------------------
1 | export * from "./Decorator"
2 | export * from "./FileData"


--------------------------------------------------------------------------------
/src/functions/index.ts:
--------------------------------------------------------------------------------
1 | export * from "./getMime"
2 | export * from "./getExtension"


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | *.log
2 | .DS_Store
3 | node_modules
4 | .cache
5 | dist
6 | example
7 | 
8 | 


--------------------------------------------------------------------------------
/.eslintignore:
--------------------------------------------------------------------------------
1 | build/
2 | dist/
3 | node_modules/
4 | .snapshots/
5 | *.min.js
6 | *.stories.tsx


--------------------------------------------------------------------------------
/doc/assets/icons.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Em3ODMe/react-ipfs/HEAD/doc/assets/icons.png


--------------------------------------------------------------------------------
/doc/assets/widgets.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Em3ODMe/react-ipfs/HEAD/doc/assets/widgets.png


--------------------------------------------------------------------------------
/doc/assets/icons@2x.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Em3ODMe/react-ipfs/HEAD/doc/assets/icons@2x.png


--------------------------------------------------------------------------------
/doc/assets/widgets@2x.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Em3ODMe/react-ipfs/HEAD/doc/assets/widgets@2x.png


--------------------------------------------------------------------------------
/examples/public/favicon.ico:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Em3ODMe/react-ipfs/HEAD/examples/public/favicon.ico


--------------------------------------------------------------------------------
/examples/public/logo192.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Em3ODMe/react-ipfs/HEAD/examples/public/logo192.png


--------------------------------------------------------------------------------
/examples/public/logo512.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Em3ODMe/react-ipfs/HEAD/examples/public/logo512.png


--------------------------------------------------------------------------------
/examples/public/robots.txt:
--------------------------------------------------------------------------------
1 | # https://www.robotstxt.org/robotstxt.html
2 | User-agent: *
3 | Disallow:
4 | 


--------------------------------------------------------------------------------
/src/types/IPFSContext.ts:
--------------------------------------------------------------------------------
1 | import { Decorator } from "../classes";
2 | 
3 | export type IPFSContext = Decorator


--------------------------------------------------------------------------------
/src/hooks/index.tsx:
--------------------------------------------------------------------------------
1 | //export * from "./useIPFSFolderState"
2 | export * from "./useStartIPFS"
3 | export * from "./useIPFS"


--------------------------------------------------------------------------------
/src/functions/getExtension.ts:
--------------------------------------------------------------------------------
1 | export function getExtension(url: string) {
2 |     return url.slice((url.lastIndexOf(".") - 1 >>> 0) + 2)
3 | }


--------------------------------------------------------------------------------
/src/index.ts:
--------------------------------------------------------------------------------
1 | export * from "./classes"
2 | export * from "./context"
3 | export * from "./functions"
4 | export * from "./hooks"
5 | export * from "./types"


--------------------------------------------------------------------------------
/examples/src/setupTests.ts:
--------------------------------------------------------------------------------
1 | // jest-dom adds custom jest matchers for asserting on DOM nodes.
2 | // allows you to do things like:
3 | // expect(element).toHaveTextContent(/react/i)
4 | // learn more: https://github.com/testing-library/jest-dom
5 | import '@testing-library/jest-dom';
6 | 


--------------------------------------------------------------------------------
/examples/tsconfig.paths.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "compilerOptions": {
 3 |         "baseUrl": ".",
 4 |         "paths": {
 5 |             "@/*": [
 6 |                 "./src"
 7 |             ],
 8 |             "@lib": [
 9 |                 "../dist/react-ipfs.esm.js"
10 |             ]
11 |         }
12 |     }
13 | }


--------------------------------------------------------------------------------
/examples/src/App.test.tsx:
--------------------------------------------------------------------------------
 1 | import React from 'react';
 2 | import { render, screen } from '@testing-library/react';
 3 | import App from './App';
 4 | 
 5 | test('renders learn react link', () => {
 6 |   render(<App />);
 7 |   const linkElement = screen.getByText(/learn react/i);
 8 |   expect(linkElement).toBeInTheDocument();
 9 | });
10 | 


--------------------------------------------------------------------------------
/test/blah.test.tsx:
--------------------------------------------------------------------------------
 1 | import * as React from 'react';
 2 | import * as ReactDOM from 'react-dom';
 3 | import { Thing } from '../src';
 4 | 
 5 | describe('it', () => {
 6 |   it('renders without crashing', () => {
 7 |     const div = document.createElement('div');
 8 |     ReactDOM.render(<Thing />, div);
 9 |     ReactDOM.unmountComponentAtNode(div);
10 |   });
11 | });
12 | 


--------------------------------------------------------------------------------
/examples/src/index.tsx:
--------------------------------------------------------------------------------
 1 | import React from 'react';
 2 | import ReactDOM from 'react-dom';
 3 | import './index.css';
 4 | import App from './App';
 5 | import { IPFSProvider } from "@lib"
 6 | 
 7 | ReactDOM.render(
 8 |   <React.StrictMode>
 9 |     <IPFSProvider fallback={<>LOADiNG</>}>
10 |       <App />
11 |     </IPFSProvider>
12 |   </React.StrictMode>,
13 |   document.getElementById('root')
14 | );


--------------------------------------------------------------------------------
/examples/config-overrides.js:
--------------------------------------------------------------------------------
 1 | const {
 2 |     override,
 3 |     removeModuleScopePlugin,
 4 |     addWebpackAlias
 5 | } = require("customize-cra");
 6 | const path = require("path");
 7 | 
 8 | module.exports = override(
 9 |     removeModuleScopePlugin(),
10 |     addWebpackAlias({
11 |         "@": path.resolve(__dirname, "./src"),
12 |         "@lib": path.resolve(__dirname, "../dist/react-ipfs.esm.js")
13 |       }),
14 | );
15 | 


--------------------------------------------------------------------------------
/examples/.gitignore:
--------------------------------------------------------------------------------
 1 | # See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
 2 | 
 3 | # dependencies
 4 | /node_modules
 5 | /.pnp
 6 | .pnp.js
 7 | 
 8 | # testing
 9 | /coverage
10 | 
11 | # production
12 | /build
13 | 
14 | # misc
15 | .DS_Store
16 | .env.local
17 | .env.development.local
18 | .env.test.local
19 | .env.production.local
20 | 
21 | npm-debug.log*
22 | yarn-debug.log*
23 | yarn-error.log*
24 | 


--------------------------------------------------------------------------------
/examples/src/index.css:
--------------------------------------------------------------------------------
 1 | body {
 2 |   margin: 0;
 3 |   font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', 'Roboto', 'Oxygen',
 4 |     'Ubuntu', 'Cantarell', 'Fira Sans', 'Droid Sans', 'Helvetica Neue',
 5 |     sans-serif;
 6 |   -webkit-font-smoothing: antialiased;
 7 |   -moz-osx-font-smoothing: grayscale;
 8 | }
 9 | 
10 | code {
11 |   font-family: source-code-pro, Menlo, Monaco, Consolas, 'Courier New',
12 |     monospace;
13 | }
14 | 


--------------------------------------------------------------------------------
/src/hooks/useIPFS.tsx:
--------------------------------------------------------------------------------
 1 | import { useContext } from "react";
 2 | import { IPFSGlobalContext } from "../context/ipfs";
 3 | import { IPFSContext } from "../types/IPFSContext";
 4 | 
 5 | export const useIPFS = (): IPFSContext => {
 6 |     const context = useContext<IPFSContext>(IPFSGlobalContext);
 7 | 
 8 |     if (context === undefined) {
 9 |         throw new Error('The useIPFS hook must be used within a IPFSGlobalContext.Provider')
10 |     } else {
11 |         return context as IPFSContext
12 |     }
13 | }


--------------------------------------------------------------------------------
/.eslintrc:
--------------------------------------------------------------------------------
 1 | {
 2 |   "parser": "@typescript-eslint/parser",
 3 |   "parserOptions": {
 4 |     "ecmaVersion": 2020,
 5 |     "sourceType": "module",
 6 |     "ecmaFeatures": {
 7 |       "jsx": true
 8 |     }
 9 |   },
10 |   "settings": {
11 |     "react": {
12 |       "version": "detect"
13 |     }
14 |   },
15 |   "extends": [
16 |     "plugin:react/recommended",
17 |     "plugin:@typescript-eslint/recommended",
18 |     "prettier/@typescript-eslint",
19 |     "plugin:prettier/recommended"
20 |   ],
21 |   "rules": {}
22 | }


--------------------------------------------------------------------------------
/src/functions/getMime.ts:
--------------------------------------------------------------------------------
 1 | export function getMime(extension: string) {
 2 |     return (
 3 |         ({
 4 |             "svg": "image/svg+xml",
 5 |             "webp": "image/webp",
 6 |             "png": "image/png",
 7 |             "jpeg": "image/jpeg",
 8 |             "jpg": "image/jpeg",
 9 |             "jfif": "image/jpeg",
10 |             "pjpeg": "image/jpeg",
11 |             "pjp": "image/jpeg",
12 |             "gif": "image/gif",
13 |             "avif": "image/avif",
14 |             "apng": "image/apng"
15 |         } as any)[extension] || "")
16 | }


--------------------------------------------------------------------------------
/examples/public/manifest.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "short_name": "React App",
 3 |   "name": "Create React App Sample",
 4 |   "icons": [
 5 |     {
 6 |       "src": "favicon.ico",
 7 |       "sizes": "64x64 32x32 24x24 16x16",
 8 |       "type": "image/x-icon"
 9 |     },
10 |     {
11 |       "src": "logo192.png",
12 |       "type": "image/png",
13 |       "sizes": "192x192"
14 |     },
15 |     {
16 |       "src": "logo512.png",
17 |       "type": "image/png",
18 |       "sizes": "512x512"
19 |     }
20 |   ],
21 |   "start_url": ".",
22 |   "display": "standalone",
23 |   "theme_color": "#000000",
24 |   "background_color": "#ffffff"
25 | }
26 | 


--------------------------------------------------------------------------------
/rollup.config.js:
--------------------------------------------------------------------------------
 1 | import commonjs from "@rollup/plugin-commonjs";
 2 | import resolve from "@rollup/plugin-node-resolve";
 3 | import peerDepsExternal from "rollup-plugin-peer-deps-external";
 4 | import typescript from "rollup-plugin-typescript2";
 5 | 
 6 | import packageJson from "./package.json";
 7 | 
 8 | export default {
 9 |   input: "./src/index.ts",
10 |   output: [
11 |     {
12 |       file: packageJson.main,
13 |       format: "cjs",
14 |       sourcemap: true
15 |     },
16 |     {
17 |       file: packageJson.module,
18 |       format: "esm",
19 |       sourcemap: true
20 |     }
21 |   ],
22 |   plugins: [peerDepsExternal(), resolve(), commonjs(), typescript()]
23 | };


--------------------------------------------------------------------------------
/tsdoc.json:
--------------------------------------------------------------------------------
 1 | {
 2 | 	"plugins": [
 3 | 		"plugins/markdown"
 4 | 	],
 5 | 	"templates": {
 6 | 		"cleverLinks": false,
 7 | 		"monospaceLinks": false
 8 | 	},
 9 | 	"source": {
10 | 		"includePattern": "(\\.d)?\\.ts$"
11 | 	},
12 | 	"markdown": {
13 | 		"parser": "gfm",
14 | 		"hardwrap": true
15 | 	},
16 | 	"tsdoc": {
17 | 		"source": "/home/youaresoroman/Documents/github/react-ipfs/src/",
18 | 		"destination": "/home/youaresoroman/Documents/github/react-ipfs/docs",
19 | 		"tutorials": "",
20 | 		"systemName": "react-ipfs",
21 | 		"footer": "",
22 | 		"copyright": "react-ipfs Copyright © 2021 youaresoroman",
23 | 		"outputSourceFiles": true,
24 | 		"commentsOnly": false
25 | 	}
26 | }


--------------------------------------------------------------------------------
/examples/tsconfig.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "extends": "./tsconfig.paths.json",
 3 |   "compilerOptions": {
 4 |     "target": "es5",
 5 |     "lib": [
 6 |       "dom",
 7 |       "dom.iterable",
 8 |       "esnext"
 9 |     ],
10 |     "allowJs": true,
11 |     "skipLibCheck": true,
12 |     "esModuleInterop": true,
13 |     "allowSyntheticDefaultImports": true,
14 |     "strict": true,
15 |     "forceConsistentCasingInFileNames": true,
16 |     "noFallthroughCasesInSwitch": true,
17 |     "module": "esnext",
18 |     "moduleResolution": "node",
19 |     "resolveJsonModule": true,
20 |     "isolatedModules": true,
21 |     "noEmit": true,
22 |     "jsx": "react-jsx"
23 |   },
24 |   "include": [
25 |     "src"
26 |   ]
27 | }
28 | 


--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/feature_request.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | name: Feature request
 3 | about: Suggest an idea for this project
 4 | title: ''
 5 | labels: ''
 6 | assignees: ''
 7 | 
 8 | ---
 9 | 
10 | **Is your feature request related to a problem? Please describe.**
11 | A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12 | 
13 | **Describe the solution you'd like**
14 | A clear and concise description of what you want to happen.
15 | 
16 | **Describe alternatives you've considered**
17 | A clear and concise description of any alternative solutions or features you've considered.
18 | 
19 | **Additional context**
20 | Add any other context or screenshots about the feature request here.
21 | 


--------------------------------------------------------------------------------
/examples/src/App.css:
--------------------------------------------------------------------------------
 1 | .App {
 2 |   text-align: center;
 3 | }
 4 | 
 5 | .App-logo {
 6 |   height: 40vmin;
 7 |   pointer-events: none;
 8 | }
 9 | 
10 | @media (prefers-reduced-motion: no-preference) {
11 |   .App-logo {
12 |     animation: App-logo-spin infinite 20s linear;
13 |   }
14 | }
15 | 
16 | .App-header {
17 |   background-color: #282c34;
18 |   min-height: 100vh;
19 |   display: flex;
20 |   flex-direction: column;
21 |   align-items: center;
22 |   justify-content: center;
23 |   font-size: calc(10px + 2vmin);
24 |   color: white;
25 | }
26 | 
27 | .App-link {
28 |   color: #61dafb;
29 | }
30 | 
31 | @keyframes App-logo-spin {
32 |   from {
33 |     transform: rotate(0deg);
34 |   }
35 |   to {
36 |     transform: rotate(360deg);
37 |   }
38 | }
39 | 


--------------------------------------------------------------------------------
/doc/assets/highlight.css:
--------------------------------------------------------------------------------
 1 | :root {
 2 |     --light-hl-0: #000000;
 3 |     --dark-hl-0: #D4D4D4;
 4 |     --light-code-background: #FFFFFF;
 5 |     --dark-code-background: #1E1E1E;
 6 | }
 7 | 
 8 | @media (prefers-color-scheme: light) { :root {
 9 |     --hl-0: var(--light-hl-0);
10 |     --code-background: var(--light-code-background);
11 | } }
12 | 
13 | @media (prefers-color-scheme: dark) { :root {
14 |     --hl-0: var(--dark-hl-0);
15 |     --code-background: var(--dark-code-background);
16 | } }
17 | 
18 | body.light {
19 |     --hl-0: var(--light-hl-0);
20 |     --code-background: var(--light-code-background);
21 | }
22 | 
23 | body.dark {
24 |     --hl-0: var(--dark-hl-0);
25 |     --code-background: var(--dark-code-background);
26 | }
27 | 
28 | .hl-0 { color: var(--hl-0); }
29 | pre, code { background: var(--code-background); }
30 | 


--------------------------------------------------------------------------------
/src/context/ipfs.tsx:
--------------------------------------------------------------------------------
 1 | import React, { createContext, ReactChild, useEffect, useState } from "react";
 2 | import { IPFSContext } from "../types/IPFSContext";
 3 | import { useStartIPFS } from "../hooks/useStartIPFS";
 4 | import { Decorator } from "../classes";
 5 | 
 6 | export const IPFSGlobalContext = createContext<IPFSContext>(new Decorator(null));
 7 | 
 8 | export const IPFSProvider = ({ children, fallback }: { children: ReactChild, fallback?: ReactChild }) => {
 9 |     const ipfs = useStartIPFS()
10 |     const [instance, setInstance] = useState<Decorator>(new Decorator(null))
11 | 
12 |     useEffect(() => {
13 |         if (ipfs) { setInstance(new Decorator(ipfs)) }
14 |     }, [ipfs])
15 | 
16 |     return (
17 |         <IPFSGlobalContext.Provider value={instance}>
18 |             {fallback && ipfs === null ? fallback : children}
19 |         </IPFSGlobalContext.Provider>
20 |     )
21 | }


--------------------------------------------------------------------------------
/src/hooks/useStartIPFS.tsx:
--------------------------------------------------------------------------------
 1 | import { useEffect, useState } from "react";
 2 | import { IPFS } from "ipfs";
 3 | import Ipfs from "ipfs"
 4 | 
 5 | export const useStartIPFS = () => {
 6 |     const [ipfs, setIpfs] = useState<IPFS | null>(null)
 7 | 
 8 |     const startIpfs = async () => {
 9 |         if (!ipfs) {
10 |             try {
11 |                 console.log("%cIPFS Started", "color: green")
12 |                 setIpfs(await Ipfs.create())
13 |             } catch (error) {
14 |                 setIpfs(null)
15 |                 console.log(`%c${error}`, "color:red")
16 |             }
17 |         }
18 |     }
19 | 
20 |     useEffect(() => {
21 |         startIpfs()
22 |         return function cleanup() {
23 |             if (ipfs && ipfs.stop) {
24 |                 console.log("Stopping IPFS")
25 |                 ipfs.stop().catch((error: Error) => console.log(`%c${error}`, "color:red"))
26 |                 setIpfs(null)
27 |             }
28 |         }
29 |     }, [])
30 | 
31 |     return ipfs
32 | }


--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/bug_report.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | name: Bug report
 3 | about: Create a report to help us improve
 4 | title: ''
 5 | labels: ''
 6 | assignees: ''
 7 | 
 8 | ---
 9 | 
10 | **Describe the bug**
11 | A clear and concise description of what the bug is.
12 | 
13 | **To Reproduce**
14 | Steps to reproduce the behavior:
15 | 1. Go to '...'
16 | 2. Click on '....'
17 | 3. Scroll down to '....'
18 | 4. See error
19 | 
20 | **Expected behavior**
21 | A clear and concise description of what you expected to happen.
22 | 
23 | **Screenshots**
24 | If applicable, add screenshots to help explain your problem.
25 | 
26 | **Desktop (please complete the following information):**
27 |  - OS: [e.g. iOS]
28 |  - Browser [e.g. chrome, safari]
29 |  - Version [e.g. 22]
30 | 
31 | **Smartphone (please complete the following information):**
32 |  - Device: [e.g. iPhone6]
33 |  - OS: [e.g. iOS8.1]
34 |  - Browser [e.g. stock browser, safari]
35 |  - Version [e.g. 22]
36 | 
37 | **Additional context**
38 | Add any other context about the problem here.
39 | 


--------------------------------------------------------------------------------
/src/classes/FileData.ts:
--------------------------------------------------------------------------------
 1 | import { getExtension, getMime } from "../functions";
 2 | import { concat } from "uint8arrays";
 3 | 
 4 | export class FileData {
 5 |     content: Uint8Array;
 6 |     fileName: string;
 7 | 
 8 |     constructor(content: Uint8Array[], fileName: string) {
 9 |         this.content = concat(content)
10 |         this.fileName = fileName
11 |     }
12 | 
13 |     toFile() {
14 |         const filename = this.fileName.split('/').pop() || "image"
15 |         const extension = getExtension(this.fileName)
16 |         const type = getMime(extension)
17 |         return new File([this.toBlob()], filename, { type })
18 |     }
19 | 
20 |     toString() {
21 |         const decode = new TextDecoder()
22 |         return decode.decode(this.content)
23 |     }
24 | 
25 |     toJSON() {
26 |         return JSON.parse(this.toString())
27 |     }
28 | 
29 |     toBlob() {
30 |         return new Blob([this.content])
31 |     }
32 | 
33 |     toObjectURL(blob?: Blob | File) {
34 |         return URL.createObjectURL(blob ? blob : this.toBlob())
35 |     }
36 | }
37 | 


--------------------------------------------------------------------------------
/CONTRIBUTING.md:
--------------------------------------------------------------------------------
 1 | # Contribute
 2 | 
 3 | ## Your First Contribution
 4 | 
 5 | Working on your first Pull Request? You can learn how from this *free* series, [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github).
 6 | 
 7 | ## Submitting code
 8 | 
 9 | Any code change should be submitted as a pull request. The description should explain what the code does and give steps to execute it. The pull request should also contain tests.
10 | 
11 | ## Code review process
12 | 
13 | The bigger the pull request, the longer it will take to review and merge. Try to break down large pull requests in smaller chunks that are easier to review and merge.
14 | It is also always helpful to have some context for your pull request. What was the purpose? Why does it matter to you?
15 | 
16 | ## Questions
17 | 
18 | If you have any questions, create an [issue](https://github.com/youaresoroman/react-ipfs/issues) (protip: do a quick search first to see if someone else didn't ask the same question before!).
19 | You can also reach by [telegram group](https://t.me/react_ipfs) or #ipfs-awesome:matrix.org
20 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | MIT License
 2 | 
 3 | Copyright (c) 2021 Roman Yankowski
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.


--------------------------------------------------------------------------------
/examples/src/App.tsx:
--------------------------------------------------------------------------------
 1 | import React from 'react';
 2 | import '@/App.css';
 3 | import { useIPFS } from '@lib';
 4 | 
 5 | function App() {
 6 |   const ipfs = useIPFS()
 7 | 
 8 |   return (
 9 |     <div className="App">
10 |       <header className="App-header">
11 |         <button onClick={(e) => {
12 |           e.preventDefault();
13 |           ipfs.stop();
14 |         }}>
15 |           Stop
16 |         </button>
17 |         <button onClick={(e) => {
18 |           e.preventDefault();
19 |           ipfs.start();
20 |         }}>
21 |           Start
22 |         </button>
23 |         <button onClick={(e) => {
24 |           e.preventDefault();
25 |           ipfs.id().then(console.log);
26 |         }}>
27 |           ID
28 |         </button>
29 |         <button onClick={(e) => {
30 |           e.preventDefault();
31 |           ipfs.cat("QmUtR5T9WxaMW9Q4J47RXQU4n7hRvsn8beewhLEMcg4ahR").then(console.log);
32 |         }}>
33 |           cat
34 |         </button>
35 |         <button onClick={(e) => {
36 |           e.preventDefault();
37 |           ipfs.add({ content: "Hello world" }).then(console.log);
38 |         }}>
39 |           add
40 |         </button>
41 |       </header>
42 |     </div >
43 |   );
44 | }
45 | 
46 | export default App;
47 | 


--------------------------------------------------------------------------------
/examples/package.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "examples",
 3 |   "version": "0.1.0",
 4 |   "private": true,
 5 |   "dependencies": {
 6 |     "@testing-library/jest-dom": "^5.15.0",
 7 |     "@testing-library/react": "^11.2.7",
 8 |     "@testing-library/user-event": "^12.8.3",
 9 |     "@types/jest": "file:../node_modules/types/jest",
10 |     "@types/node": "file:../node_modules/types/node",
11 |     "@types/react": "file:../node_modules/types/react",
12 |     "@types/react-dom": "file:../node_modules/types/react-dom",
13 |     "customize-cra": "^1.0.0",
14 |     "react": "file:../node_modules/react",
15 |     "react-app-rewired": "^2.1.8",
16 |     "react-dom": "file:../node_modules/react-dom",
17 |     "react-scripts": "4.0.3",
18 |     "typescript": "^4.4.4"
19 |   },
20 |   "scripts": {
21 |     "start": "react-app-rewired start",
22 |     "build": "react-app-rewired build",
23 |     "test": "react-app-rewired test",
24 |     "eject": "react-scripts eject"
25 |   },
26 |   "eslintConfig": {
27 |     "extends": [
28 |       "react-app",
29 |       "react-app/jest"
30 |     ]
31 |   },
32 |   "browserslist": {
33 |     "production": [
34 |       ">0.2%",
35 |       "not dead",
36 |       "not op_mini all"
37 |     ],
38 |     "development": [
39 |       "last 1 chrome version",
40 |       "last 1 firefox version",
41 |       "last 1 safari version"
42 |     ]
43 |   }
44 | }
45 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | <div align="center">
 2 | 
 3 | # react-ipfs
 4 | 
 5 | React IPFS instance hooks for easier usage in your DAPPS
 6 | 
 7 | 
 8 |  ![npm](https://img.shields.io/npm/dw/react-ipfs) ![David](https://img.shields.io/david/youaresoroman/react-ipfs) ![GitHub package.json dependency version (prod)](https://img.shields.io/github/package-json/dependency-version/youaresoroman/react-ipfs/ipfs) ![GitHub top language](https://img.shields.io/github/languages/top/youaresoroman/react-ipfs) ![NPM](https://img.shields.io/npm/l/react-ipfs) ![Matrix](https://img.shields.io/matrix/ipfs-awesome:matrix.org?server_fqdn=matrix.org)
 9 | 
10 |  </div>
11 | 
12 | ## Installation
13 | 
14 | ### npm
15 | 
16 | ```bash
17 | npm install react-ipfs
18 | ```
19 | 
20 | ### yarn
21 | ```bash
22 | yarn add react-ipfs
23 | ```
24 | ## Documentation
25 | TSDoc compiled documentation is [here](https://youaresoroman.github.io/react-ipfs/)
26 | 
27 | ## Usage
28 | 
29 | src/index.tsx
30 | ```js
31 | import { IPFSProvider } from "react-ipfs"
32 | 
33 | ....
34 |     <IPFSProvider fallback={<>LOADING</>}>
35 |       <App />
36 |     </IPFSProvider>
37 | ...
38 | ```
39 | 
40 | src/App.tsx
41 | ```js
42 | import { useIPFS } from '@lib';
43 | 
44 | function App() {
45 |   const ipfs = useIPFS()
46 | 
47 |   useEffect(()=>{
48 |       ipfs.node.id().then(console.log);
49 |   },[])
50 | 
51 | ...
52 | ```
53 | ## Contribute
54 | 
55 | Please see the [contributing guidelines](./CONTRIBUTING.md)
56 | 


--------------------------------------------------------------------------------
/examples/public/index.html:
--------------------------------------------------------------------------------
 1 | <!DOCTYPE html>
 2 | <html lang="en">
 3 |   <head>
 4 |     <meta charset="utf-8" />
 5 |     <link rel="icon" href="%PUBLIC_URL%/favicon.ico" />
 6 |     <meta name="viewport" content="width=device-width, initial-scale=1" />
 7 |     <meta name="theme-color" content="#000000" />
 8 |     <meta
 9 |       name="description"
10 |       content="Web site created using create-react-app"
11 |     />
12 |     <link rel="apple-touch-icon" href="%PUBLIC_URL%/logo192.png" />
13 |     <!--
14 |       manifest.json provides metadata used when your web app is installed on a
15 |       user's mobile device or desktop. See https://developers.google.com/web/fundamentals/web-app-manifest/
16 |     -->
17 |     <link rel="manifest" href="%PUBLIC_URL%/manifest.json" />
18 |     <!--
19 |       Notice the use of %PUBLIC_URL% in the tags above.
20 |       It will be replaced with the URL of the `public` folder during the build.
21 |       Only files inside the `public` folder can be referenced from the HTML.
22 | 
23 |       Unlike "/favicon.ico" or "favicon.ico", "%PUBLIC_URL%/favicon.ico" will
24 |       work correctly both with client-side routing and a non-root public URL.
25 |       Learn how to configure a non-root public URL by running `npm run build`.
26 |     -->
27 |     <title>React App</title>
28 |   </head>
29 |   <body>
30 |     <noscript>You need to enable JavaScript to run this app.</noscript>
31 |     <div id="root"></div>
32 |     <!--
33 |       This HTML file is a template.
34 |       If you open it directly in the browser, you will see an empty page.
35 | 
36 |       You can add webfonts, meta tags, or analytics to this file.
37 |       The build step will place the bundled scripts into the <body> tag.
38 | 
39 |       To begin the development, run `npm start` or `yarn start`.
40 |       To create a production bundle, use `npm run build` or `yarn build`.
41 |     -->
42 |   </body>
43 | </html>
44 | 


--------------------------------------------------------------------------------
/tsconfig.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   // see https://www.typescriptlang.org/tsconfig to better understand tsconfigs
 3 |   "include": [
 4 |     "src",
 5 |     "types"
 6 |   ],
 7 |   "typedocOptions": {
 8 |     "entryPoints": [
 9 |       "./src/classes",
10 |       "./src/context",
11 |       "./src/hooks",
12 |       "./src/functions",
13 |       "./src/types",
14 |     ],
15 |     "out": "doc",
16 |     "pretty": true
17 |   },
18 |   "compilerOptions": {
19 |     "module": "esnext",
20 |     "target": "ESNext",
21 |     "lib": [
22 |       "dom",
23 |       "esnext"
24 |     ],
25 |     "importHelpers": true,
26 |     // output .d.ts declaration files for consumers
27 |     "declaration": true,
28 |     "declarationDir": "./dist/types/",
29 |     // output .js.map sourcemap files for consumers
30 |     "sourceMap": true,
31 |     // match output dir to input dir. e.g. dist/index instead of dist/src/index
32 |     "rootDir": "./src",
33 |     "baseUrl": "./src",
34 |     // stricter type-checking for stronger correctness. Recommended by TS
35 |     "strict": true,
36 |     // linter checks for common issues
37 |     "noImplicitReturns": true,
38 |     "noFallthroughCasesInSwitch": true,
39 |     // noUnused* overlap with @typescript-eslint/no-unused-vars, can disable if duplicative
40 |     "noUnusedLocals": true,
41 |     "noUnusedParameters": true,
42 |     // use Node's module resolution algorithm, instead of the legacy TS one
43 |     "moduleResolution": "node",
44 |     // transpile JSX to React.createElement
45 |     "jsx": "react",
46 |     // interop between ESM and CJS modules. Recommended by TS
47 |     "esModuleInterop": true,
48 |     // significant perf increase by skipping checking .d.ts files, particularly those in node_modules. Recommended by TS
49 |     "skipLibCheck": true,
50 |     // error out if import and file system have a casing mismatch. Recommended by TS
51 |     "forceConsistentCasingInFileNames": true,
52 |     // `tsdx build` ignores this option, but it is commonly used when type-checking separately with `tsc`
53 |     "noEmit": true
54 |   }
55 | }


--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "version": "0.3.0",
 3 |   "license": "MIT",
 4 |   "main": "dist/index.js",
 5 |   "typings": "dist/types/index.d.ts",
 6 |   "files": [
 7 |     "dist",
 8 |     "src"
 9 |   ],
10 |   "engines": {
11 |     "node": ">=10"
12 |   },
13 |   "scripts": {
14 |     "start": "tsdx watch",
15 |     "build": "tsdx build",
16 |     "test": "tsdx test --passWithNoTests",
17 |     "lint": "tsdx lint",
18 |     "prepare": "tsdx build",
19 |     "size": "size-limit",
20 |     "analyze": "size-limit --why",
21 |     "start:examples": "cd examples && npm start",
22 |     "install:examples": "cd examples && npm install",
23 |     "documentation": "npx typedoc"
24 |   },
25 |   "peerDependencies": {
26 |     "react": ">=16"
27 |   },
28 |   "husky": {
29 |     "hooks": {
30 |       "pre-commit": "tsdx lint"
31 |     }
32 |   },
33 |   "prettier": {
34 |     "printWidth": 80,
35 |     "semi": true,
36 |     "singleQuote": true,
37 |     "trailingComma": "es5"
38 |   },
39 |   "name": "react-ipfs",
40 |   "author": "Roman Yankowski",
41 |   "repository": {
42 |     "type": "git",
43 |     "url": "git+https://github.com/youaresoroman/react-ipfs.git"
44 |   },
45 |   "keywords": [
46 |     "React",
47 |     "Component",
48 |     "Library",
49 |     "Rollup",
50 |     "Typescript",
51 |     "User Interface",
52 |     "Storybook",
53 |     "IPFS"
54 |   ],
55 |   "bugs": {
56 |     "url": "https://github.com/youaresoroman/react-ipfs/issues"
57 |   },
58 |   "homepage": "https://github.com/youaresoroman/react-ipfs#readme",
59 |   "module": "dist/react-ipfs.esm.js",
60 |   "size-limit": [
61 |     {
62 |       "path": "dist/react-ipfs.cjs.production.min.js",
63 |       "limit": "10 KB"
64 |     },
65 |     {
66 |       "path": "dist/react-ipfs.esm.js",
67 |       "limit": "10 KB"
68 |     }
69 |   ],
70 |   "devDependencies": {
71 |     "@size-limit/preset-small-lib": "^5.0.3",
72 |     "@types/react": "^17.0.34",
73 |     "@types/react-dom": "^17.0.11",
74 |     "eslint-config-prettier": "^8.3.0",
75 |     "eslint-plugin-prettier": "^4.0.0",
76 |     "husky": "^7.0.2",
77 |     "prettier": "^2.4.1",
78 |     "react": "^17.0.2",
79 |     "react-dom": "^17.0.2",
80 |     "size-limit": "^5.0.3",
81 |     "tsdx": "^0.14.1",
82 |     "tslib": "^2.3.1",
83 |     "typedoc": "^0.22.3",
84 |     "typescript": "^4.4.4"
85 |   },
86 |   "dependencies": {
87 |     "bootstrap": "^5.1.3",
88 |     "gulp": "^4.0.2",
89 |     "ipfs": "^0.60.2",
90 |     "react-bootstrap": "^2.0.3",
91 |     "uint8arrays": "^3.0.0"
92 |   }
93 | }
94 | 


--------------------------------------------------------------------------------
/examples/src/logo.svg:
--------------------------------------------------------------------------------
1 | <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 841.9 595.3"><g fill="#61DAFB"><path d="M666.3 296.5c0-32.5-40.7-63.3-103.1-82.4 14.4-63.6 8-114.2-20.2-130.4-6.5-3.8-14.1-5.6-22.4-5.6v22.3c4.6 0 8.3.9 11.4 2.6 13.6 7.8 19.5 37.5 14.9 75.7-1.1 9.4-2.9 19.3-5.1 29.4-19.6-4.8-41-8.5-63.5-10.9-13.5-18.5-27.5-35.3-41.6-50 32.6-30.3 63.2-46.9 84-46.9V78c-27.5 0-63.5 19.6-99.9 53.6-36.4-33.8-72.4-53.2-99.9-53.2v22.3c20.7 0 51.4 16.5 84 46.6-14 14.7-28 31.4-41.3 49.9-22.6 2.4-44 6.1-63.6 11-2.3-10-4-19.7-5.2-29-4.7-38.2 1.1-67.9 14.6-75.8 3-1.8 6.9-2.6 11.5-2.6V78.5c-8.4 0-16 1.8-22.6 5.6-28.1 16.2-34.4 66.7-19.9 130.1-62.2 19.2-102.7 49.9-102.7 82.3 0 32.5 40.7 63.3 103.1 82.4-14.4 63.6-8 114.2 20.2 130.4 6.5 3.8 14.1 5.6 22.5 5.6 27.5 0 63.5-19.6 99.9-53.6 36.4 33.8 72.4 53.2 99.9 53.2 8.4 0 16-1.8 22.6-5.6 28.1-16.2 34.4-66.7 19.9-130.1 62-19.1 102.5-49.9 102.5-82.3zm-130.2-66.7c-3.7 12.9-8.3 26.2-13.5 39.5-4.1-8-8.4-16-13.1-24-4.6-8-9.5-15.8-14.4-23.4 14.2 2.1 27.9 4.7 41 7.9zm-45.8 106.5c-7.8 13.5-15.8 26.3-24.1 38.2-14.9 1.3-30 2-45.2 2-15.1 0-30.2-.7-45-1.9-8.3-11.9-16.4-24.6-24.2-38-7.6-13.1-14.5-26.4-20.8-39.8 6.2-13.4 13.2-26.8 20.7-39.9 7.8-13.5 15.8-26.3 24.1-38.2 14.9-1.3 30-2 45.2-2 15.1 0 30.2.7 45 1.9 8.3 11.9 16.4 24.6 24.2 38 7.6 13.1 14.5 26.4 20.8 39.8-6.3 13.4-13.2 26.8-20.7 39.9zm32.3-13c5.4 13.4 10 26.8 13.8 39.8-13.1 3.2-26.9 5.9-41.2 8 4.9-7.7 9.8-15.6 14.4-23.7 4.6-8 8.9-16.1 13-24.1zM421.2 430c-9.3-9.6-18.6-20.3-27.8-32 9 .4 18.2.7 27.5.7 9.4 0 18.7-.2 27.8-.7-9 11.7-18.3 22.4-27.5 32zm-74.4-58.9c-14.2-2.1-27.9-4.7-41-7.9 3.7-12.9 8.3-26.2 13.5-39.5 4.1 8 8.4 16 13.1 24 4.7 8 9.5 15.8 14.4 23.4zM420.7 163c9.3 9.6 18.6 20.3 27.8 32-9-.4-18.2-.7-27.5-.7-9.4 0-18.7.2-27.8.7 9-11.7 18.3-22.4 27.5-32zm-74 58.9c-4.9 7.7-9.8 15.6-14.4 23.7-4.6 8-8.9 16-13 24-5.4-13.4-10-26.8-13.8-39.8 13.1-3.1 26.9-5.8 41.2-7.9zm-90.5 125.2c-35.4-15.1-58.3-34.9-58.3-50.6 0-15.7 22.9-35.6 58.3-50.6 8.6-3.7 18-7 27.7-10.1 5.7 19.6 13.2 40 22.5 60.9-9.2 20.8-16.6 41.1-22.2 60.6-9.9-3.1-19.3-6.5-28-10.2zM310 490c-13.6-7.8-19.5-37.5-14.9-75.7 1.1-9.4 2.9-19.3 5.1-29.4 19.6 4.8 41 8.5 63.5 10.9 13.5 18.5 27.5 35.3 41.6 50-32.6 30.3-63.2 46.9-84 46.9-4.5-.1-8.3-1-11.3-2.7zm237.2-76.2c4.7 38.2-1.1 67.9-14.6 75.8-3 1.8-6.9 2.6-11.5 2.6-20.7 0-51.4-16.5-84-46.6 14-14.7 28-31.4 41.3-49.9 22.6-2.4 44-6.1 63.6-11 2.3 10.1 4.1 19.8 5.2 29.1zm38.5-66.7c-8.6 3.7-18 7-27.7 10.1-5.7-19.6-13.2-40-22.5-60.9 9.2-20.8 16.6-41.1 22.2-60.6 9.9 3.1 19.3 6.5 28.1 10.2 35.4 15.1 58.3 34.9 58.3 50.6-.1 15.7-23 35.6-58.4 50.6zM320.8 78.4z"/><circle cx="420.9" cy="296.5" r="45.7"/><path d="M520.5 78.1z"/></g></svg>


--------------------------------------------------------------------------------
/src/classes/Decorator.ts:
--------------------------------------------------------------------------------
 1 | import { IPFS } from "ipfs-core-types"
 2 | //import { API as RootAPI}  from "ipfs-core-types/src/root"
 3 | //import createIDAPI from "ipfs-core/src/components/id"
 4 | //import RootAPI from "ipfs-core/src/components/root"
 5 | //import { FileData } from "../classes/FileData"
 6 | 
 7 | //type addType = RootAPI["add"]
 8 | 
 9 | //type importCandidate = Parameters<addType>[0]
10 | //type options = Parameters<addType>[1]
11 | //type idres = ReturnType<typeof createIDAPI>
12 | //type idresOptions = idres["options"]
13 | //type idresResult = 
14 | //type addReturn = ReturnType<addType>
15 | 
16 | export class Decorator {//implements RootAPI {
17 |     node: IPFS | null;
18 | 
19 |     constructor(ipfs: IPFS | null) {
20 |         this.node = ipfs
21 |     }
22 | 
23 |     start = (): Promise<void> => {
24 |         if (this.node) {
25 |             return this.node.start()
26 |                 .then(() => {
27 |                     console.log("%cIPFS Started", "color: green")
28 |                 })
29 |                 .catch((error: Error) => {
30 |                     console.log(error.message)
31 |                 })
32 |         } else {
33 |             throw new Error("IPFS node is not ready")
34 |         }
35 |     }
36 | 
37 |     stop = (): Promise<void> => {
38 |         if (this.node) {
39 |             return this.node.stop()
40 |                 .then(() => {
41 |                     console.log("Stopping IPFS")
42 |                 })
43 |                 .catch((error: Error) => {
44 |                     console.log(error.message)
45 |                 })
46 |         } else {
47 |             throw new Error("IPFS node is not ready")
48 |         }
49 |     }
50 | 
51 | 
52 | 
53 |     // id = async (options) => {
54 |     //     return new Promise((resolve) => {
55 |     //         if (this.node) {
56 |     //             return this.node.id(options)
57 |     //         } else {
58 |     //             resolve([false, new Error("IPFS node is not ready")])
59 |     //         }
60 |     //     })
61 |     // }
62 | 
63 |     // cat = async (hash: string): Promise<[FileData | null, Error | unknown | null]> => {
64 |     //     return new Promise((resolve) => {
65 |     //         (async () => {
66 |     //             if (this.node) {
67 |     //                 try {
68 |     //                     const chunks: Uint8Array[] = []
69 |     //                     for await (const chunk of this.node.cat(hash)) {
70 |     //                         chunks.push(chunk)
71 |     //                     }
72 |     //                     resolve([new FileData(chunks, hash), null])
73 | 
74 |     //                 } catch (error) {
75 |     //                     resolve([null, error])
76 |     //                 }
77 |     //             } else {
78 |     //                 resolve([null, new Error("IPFS node is not ready")])
79 |     //             }
80 |     //         })()
81 |     //     })
82 |     // }
83 | 
84 |     // add = async ({ entry, options }: { entry: importCandidate, options: options }): Promise<[boolean, Error | null]> => {
85 |     //     return new Promise((resolve) => {
86 |     //         if (this.node) {
87 |     //             this.node.add(entry, options)
88 |     //                 .then(() => resolve([true, null]))
89 |     //                 .catch((error: Error) => resolve([false, error]))
90 |     //         } else {
91 |     //             resolve([false, new Error("IPFS node is not ready")])
92 |     //         }
93 |     //     })
94 |     // }
95 | }


--------------------------------------------------------------------------------
/doc/modules.html:
--------------------------------------------------------------------------------
1 | <!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>react-ipfs</title><meta name="description" content="Documentation for react-ipfs"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script async src="assets/search.js" id="search-script"></script></head><body><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">react-ipfs</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><h1> react-ipfs</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Modules</h3><ul class="tsd-index-list"><li class="tsd-kind-module"><a href="modules/classes.html" class="tsd-kind-icon">classes</a></li><li class="tsd-kind-module"><a href="modules/context.html" class="tsd-kind-icon">context</a></li><li class="tsd-kind-module"><a href="modules/functions.html" class="tsd-kind-icon">functions</a></li><li class="tsd-kind-module"><a href="modules/hooks.html" class="tsd-kind-icon">hooks</a></li><li class="tsd-kind-module"><a href="modules/types.html" class="tsd-kind-icon">types</a></li></ul></section></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class="current"><a href="modules.html">Modules</a></li><li class=" tsd-kind-module"><a href="modules/classes.html">classes</a></li><li class=" tsd-kind-module"><a href="modules/context.html">context</a></li><li class=" tsd-kind-module"><a href="modules/functions.html">functions</a></li><li class=" tsd-kind-module"><a href="modules/hooks.html">hooks</a></li><li class=" tsd-kind-module"><a href="modules/types.html">types</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li><li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li><li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="assets/main.js"></script></body></html>


--------------------------------------------------------------------------------
/doc/modules/classes.html:
--------------------------------------------------------------------------------
1 | <!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>classes | react-ipfs</title><meta name="description" content="Documentation for react-ipfs"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">react-ipfs</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">react-ipfs</a></li><li><a href="classes.html">classes</a></li></ul><h1>Module classes</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Classes</h3><ul class="tsd-index-list"><li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/classes.IPFSDecorator.html" class="tsd-kind-icon">IPFSDecorator</a></li><li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/classes.IPFSFileData.html" class="tsd-kind-icon">IPFSFile<wbr/>Data</a></li></ul></section></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Modules</a></li><li class="current tsd-kind-module"><a href="classes.html">classes</a></li><li class=" tsd-kind-module"><a href="context.html">context</a></li><li class=" tsd-kind-module"><a href="functions.html">functions</a></li><li class=" tsd-kind-module"><a href="hooks.html">hooks</a></li><li class=" tsd-kind-module"><a href="types.html">types</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/classes.IPFSDecorator.html" class="tsd-kind-icon">IPFSDecorator</a></li><li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/classes.IPFSFileData.html" class="tsd-kind-icon">IPFSFile<wbr/>Data</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li><li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li><li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>


--------------------------------------------------------------------------------
/doc/index.html:
--------------------------------------------------------------------------------
 1 | <!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>react-ipfs</title><meta name="description" content="Documentation for react-ipfs"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script async src="assets/search.js" id="search-script"></script></head><body><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">react-ipfs</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><h1> react-ipfs</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><div class="tsd-panel tsd-typography"><div align="center">
 2 | 
 3 | 
 4 | <a href="#react-ipfs" id="react-ipfs" style="color: inherit; text-decoration: none;">
 5 |   <h1>react-ipfs</h1>
 6 | </a>
 7 | <p>React IPFS instance hooks for easier usage in your DAPPS</p>
 8 | <p> <img src="https://img.shields.io/npm/dw/react-ipfs" alt="npm"> <img src="https://img.shields.io/david/youaresoroman/react-ipfs" alt="David"> <img src="https://img.shields.io/github/package-json/dependency-version/youaresoroman/react-ipfs/ipfs" alt="GitHub package.json dependency version (prod)"> <img src="https://img.shields.io/github/languages/top/youaresoroman/react-ipfs" alt="GitHub top language"> <img src="https://img.shields.io/npm/l/react-ipfs" alt="NPM"> <img src="https://img.shields.io/matrix/ipfs-awesome:matrix.org?server_fqdn=matrix.org" alt="Matrix"></p>
 9 |  </div>
10 | 
11 | 
12 | <a href="#installation" id="installation" style="color: inherit; text-decoration: none;">
13 |   <h2>Installation</h2>
14 | </a>
15 | 
16 | <a href="#npm" id="npm" style="color: inherit; text-decoration: none;">
17 |   <h3>npm</h3>
18 | </a>
19 | <pre><code class="language-bash"><span class="hl-0">npm install react-ipfs</span>
20 | </code></pre>
21 | 
22 | <a href="#yarn" id="yarn" style="color: inherit; text-decoration: none;">
23 |   <h3>yarn</h3>
24 | </a>
25 | <pre><code class="language-bash"><span class="hl-0">yarn add react-ipfs</span>
26 | </code></pre>
27 | 
28 | <a href="#documentation" id="documentation" style="color: inherit; text-decoration: none;">
29 |   <h2>Documentation</h2>
30 | </a>
31 | <p>TSDoc compiled documentation is <a href="https://youaresoroman.github.io/react-ipfs/">here</a></p>
32 | 
33 | <a href="#contribute" id="contribute" style="color: inherit; text-decoration: none;">
34 |   <h2>Contribute</h2>
35 | </a>
36 | <p>Please see the <a href="./CONTRIBUTING.md">contributing guidelines</a></p>
37 | </div></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class="current"><a href="modules.html">Modules</a></li><li class=" tsd-kind-module"><a href="modules/classes.html">classes</a></li><li class=" tsd-kind-module"><a href="modules/context.html">context</a></li><li class=" tsd-kind-module"><a href="modules/functions.html">functions</a></li><li class=" tsd-kind-module"><a href="modules/hooks.html">hooks</a></li><li class=" tsd-kind-module"><a href="modules/types.html">types</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li><li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li><li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="assets/main.js"></script></body></html>


--------------------------------------------------------------------------------
/CODE_OF_CONDUCT.md:
--------------------------------------------------------------------------------
  1 | # Contributor Covenant Code of Conduct
  2 | 
  3 | ## Our Pledge
  4 | 
  5 | We as members, contributors, and leaders pledge to make participation in our
  6 | community a harassment-free experience for everyone, regardless of age, body
  7 | size, visible or invisible disability, ethnicity, sex characteristics, gender
  8 | identity and expression, level of experience, education, socio-economic status,
  9 | nationality, personal appearance, race, religion, or sexual identity
 10 | and orientation.
 11 | 
 12 | We pledge to act and interact in ways that contribute to an open, welcoming,
 13 | diverse, inclusive, and healthy community.
 14 | 
 15 | ## Our Standards
 16 | 
 17 | Examples of behavior that contributes to a positive environment for our
 18 | community include:
 19 | 
 20 | * Demonstrating empathy and kindness toward other people
 21 | * Being respectful of differing opinions, viewpoints, and experiences
 22 | * Giving and gracefully accepting constructive feedback
 23 | * Accepting responsibility and apologizing to those affected by our mistakes,
 24 |   and learning from the experience
 25 | * Focusing on what is best not just for us as individuals, but for the
 26 |   overall community
 27 | 
 28 | Examples of unacceptable behavior include:
 29 | 
 30 | * The use of sexualized language or imagery, and sexual attention or
 31 |   advances of any kind
 32 | * Trolling, insulting or derogatory comments, and personal or political attacks
 33 | * Public or private harassment
 34 | * Publishing others' private information, such as a physical or email
 35 |   address, without their explicit permission
 36 | * Other conduct which could reasonably be considered inappropriate in a
 37 |   professional setting
 38 | 
 39 | ## Enforcement Responsibilities
 40 | 
 41 | Community leaders are responsible for clarifying and enforcing our standards of
 42 | acceptable behavior and will take appropriate and fair corrective action in
 43 | response to any behavior that they deem inappropriate, threatening, offensive,
 44 | or harmful.
 45 | 
 46 | Community leaders have the right and responsibility to remove, edit, or reject
 47 | comments, commits, code, wiki edits, issues, and other contributions that are
 48 | not aligned to this Code of Conduct, and will communicate reasons for moderation
 49 | decisions when appropriate.
 50 | 
 51 | ## Scope
 52 | 
 53 | This Code of Conduct applies within all community spaces, and also applies when
 54 | an individual is officially representing the community in public spaces.
 55 | Examples of representing our community include using an official e-mail address,
 56 | posting via an official social media account, or acting as an appointed
 57 | representative at an online or offline event.
 58 | 
 59 | ## Enforcement
 60 | 
 61 | Instances of abusive, harassing, or otherwise unacceptable behavior may be
 62 | reported to the community leaders responsible for enforcement at
 63 | romanjankowski@groupoffice.ch.
 64 | All complaints will be reviewed and investigated promptly and fairly.
 65 | 
 66 | All community leaders are obligated to respect the privacy and security of the
 67 | reporter of any incident.
 68 | 
 69 | ## Enforcement Guidelines
 70 | 
 71 | Community leaders will follow these Community Impact Guidelines in determining
 72 | the consequences for any action they deem in violation of this Code of Conduct:
 73 | 
 74 | ### 1. Correction
 75 | 
 76 | **Community Impact**: Use of inappropriate language or other behavior deemed
 77 | unprofessional or unwelcome in the community.
 78 | 
 79 | **Consequence**: A private, written warning from community leaders, providing
 80 | clarity around the nature of the violation and an explanation of why the
 81 | behavior was inappropriate. A public apology may be requested.
 82 | 
 83 | ### 2. Warning
 84 | 
 85 | **Community Impact**: A violation through a single incident or series
 86 | of actions.
 87 | 
 88 | **Consequence**: A warning with consequences for continued behavior. No
 89 | interaction with the people involved, including unsolicited interaction with
 90 | those enforcing the Code of Conduct, for a specified period of time. This
 91 | includes avoiding interactions in community spaces as well as external channels
 92 | like social media. Violating these terms may lead to a temporary or
 93 | permanent ban.
 94 | 
 95 | ### 3. Temporary Ban
 96 | 
 97 | **Community Impact**: A serious violation of community standards, including
 98 | sustained inappropriate behavior.
 99 | 
100 | **Consequence**: A temporary ban from any sort of interaction or public
101 | communication with the community for a specified period of time. No public or
102 | private interaction with the people involved, including unsolicited interaction
103 | with those enforcing the Code of Conduct, is allowed during this period.
104 | Violating these terms may lead to a permanent ban.
105 | 
106 | ### 4. Permanent Ban
107 | 
108 | **Community Impact**: Demonstrating a pattern of violation of community
109 | standards, including sustained inappropriate behavior,  harassment of an
110 | individual, or aggression toward or disparagement of classes of individuals.
111 | 
112 | **Consequence**: A permanent ban from any sort of public interaction within
113 | the community.
114 | 
115 | ## Attribution
116 | 
117 | This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118 | version 2.0, available at
119 | https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
120 | 
121 | Community Impact Guidelines were inspired by [Mozilla's code of conduct
122 | enforcement ladder](https://github.com/mozilla/diversity).
123 | 
124 | [homepage]: https://www.contributor-covenant.org
125 | 
126 | For answers to common questions about this code of conduct, see the FAQ at
127 | https://www.contributor-covenant.org/faq. Translations are available at
128 | https://www.contributor-covenant.org/translations.
129 | 


--------------------------------------------------------------------------------
/doc/modules/functions.html:
--------------------------------------------------------------------------------
1 | <!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>functions | react-ipfs</title><meta name="description" content="Documentation for react-ipfs"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">react-ipfs</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">react-ipfs</a></li><li><a href="functions.html">functions</a></li></ul><h1>Module functions</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Functions</h3><ul class="tsd-index-list"><li class="tsd-kind-function tsd-parent-kind-module"><a href="functions.html#getExtension" class="tsd-kind-icon">get<wbr/>Extension</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="functions.html#getMime" class="tsd-kind-icon">get<wbr/>Mime</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Functions</h2><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a name="getExtension" class="tsd-anchor"></a><h3>get<wbr/>Extension</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">get<wbr/>Extension<span class="tsd-signature-symbol">(</span>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in functions/getExtension.ts:1</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>url: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a name="getMime" class="tsd-anchor"></a><h3>get<wbr/>Mime</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">get<wbr/>Mime<span class="tsd-signature-symbol">(</span>extension<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in functions/getMime.ts:1</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>extension: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Modules</a></li><li class=" tsd-kind-module"><a href="classes.html">classes</a></li><li class=" tsd-kind-module"><a href="context.html">context</a></li><li class="current tsd-kind-module"><a href="functions.html">functions</a></li><li class=" tsd-kind-module"><a href="hooks.html">hooks</a></li><li class=" tsd-kind-module"><a href="types.html">types</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-function tsd-parent-kind-module"><a href="functions.html#getExtension" class="tsd-kind-icon">get<wbr/>Extension</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="functions.html#getMime" class="tsd-kind-icon">get<wbr/>Mime</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li><li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li><li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>


--------------------------------------------------------------------------------
/doc/modules/hooks.html:
--------------------------------------------------------------------------------
1 | <!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>hooks | react-ipfs</title><meta name="description" content="Documentation for react-ipfs"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">react-ipfs</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">react-ipfs</a></li><li><a href="hooks.html">hooks</a></li></ul><h1>Module hooks</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Functions</h3><ul class="tsd-index-list"><li class="tsd-kind-function tsd-parent-kind-module"><a href="hooks.html#useIPFSFolderState" class="tsd-kind-icon">useIPFSFolder<wbr/>State</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Functions</h2><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a name="useIPFSFolderState" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> useIPFSFolder<wbr/>State</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">useIPFSFolder<wbr/>State<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{ </span>getHash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>ls<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>mkdir<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>mv<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>read<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>rm<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>write<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>writeAll<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">]</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/youaresoroman/react-ipfs/blob/3b5483a/src/hooks/index.tsx#L7">hooks/index.tsx:7</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>path: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{ </span>getHash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>ls<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>mkdir<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>mv<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>read<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>rm<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>write<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>writeAll<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">]</span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Modules</a></li><li class=" tsd-kind-module"><a href="classes.html">classes</a></li><li class=" tsd-kind-module"><a href="context.html">context</a></li><li class=" tsd-kind-module"><a href="functions.html">functions</a></li><li class="current tsd-kind-module"><a href="hooks.html">hooks</a></li><li class=" tsd-kind-module"><a href="types.html">types</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-function tsd-parent-kind-module"><a href="hooks.html#useIPFSFolderState" class="tsd-kind-icon">useIPFSFolder<wbr/>State</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li><li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li><li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>


--------------------------------------------------------------------------------
/doc/modules/types.html:
--------------------------------------------------------------------------------
1 | <!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>types | react-ipfs</title><meta name="description" content="Documentation for react-ipfs"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">react-ipfs</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">react-ipfs</a></li><li><a href="types.html">types</a></li></ul><h1>Module types</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Type aliases</h3><ul class="tsd-index-list"><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="types.html#ipfsInstance" class="tsd-kind-icon">ipfs<wbr/>Instance</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="types.html#ipfsInstanceDecorator" class="tsd-kind-icon">ipfs<wbr/>Instance<wbr/>Decorator</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Type aliases</h2><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a name="ipfsInstance" class="tsd-anchor"></a><h3>ipfs<wbr/>Instance</h3><div class="tsd-signature tsd-kind-icon">ipfs<wbr/>Instance<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">{ </span>ipfs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">IPFS</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span>isIpfsReady<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>ipfs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">IPFS</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span>isIpfsReady<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">]</span></div><aside class="tsd-sources"><ul><li>Defined in types/ipfsInterface.ts:3</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a name="ipfsInstanceDecorator" class="tsd-anchor"></a><h3>ipfs<wbr/>Instance<wbr/>Decorator</h3><div class="tsd-signature tsd-kind-icon">ipfs<wbr/>Instance<wbr/>Decorator<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">{ </span>ipfs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">IPFS</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span>isIpfsReady<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>ipfs<span class="tsd-signature-symbol">: </span><a href="../classes/classes.IPFSDecorator.html" class="tsd-signature-type" data-tsd-kind="Class">IPFSDecorator</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span>isIpfsReady<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">]</span></div><aside class="tsd-sources"><ul><li>Defined in types/ipfsInstanceDecorator.ts:4</li></ul></aside></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Modules</a></li><li class=" tsd-kind-module"><a href="classes.html">classes</a></li><li class=" tsd-kind-module"><a href="context.html">context</a></li><li class=" tsd-kind-module"><a href="functions.html">functions</a></li><li class=" tsd-kind-module"><a href="hooks.html">hooks</a></li><li class="current tsd-kind-module"><a href="types.html">types</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="types.html#ipfsInstance" class="tsd-kind-icon">ipfs<wbr/>Instance</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="types.html#ipfsInstanceDecorator" class="tsd-kind-icon">ipfs<wbr/>Instance<wbr/>Decorator</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li><li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li><li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>


--------------------------------------------------------------------------------
/doc/assets/search.js:
--------------------------------------------------------------------------------
1 | window.searchData = {"kinds":{"2":"Module","32":"Variable","64":"Function","128":"Class","512":"Constructor","1024":"Property","2048":"Method","65536":"Type literal","4194304":"Type alias"},"rows":[{"id":0,"kind":2,"name":"classes","url":"modules/classes.html","classes":"tsd-kind-module"},{"id":1,"kind":128,"name":"IPFSFileData","url":"classes/classes.IPFSFileData.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"classes"},{"id":2,"kind":512,"name":"constructor","url":"classes/classes.IPFSFileData.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"classes.IPFSFileData"},{"id":3,"kind":1024,"name":"content","url":"classes/classes.IPFSFileData.html#content","classes":"tsd-kind-property tsd-parent-kind-class","parent":"classes.IPFSFileData"},{"id":4,"kind":1024,"name":"fileName","url":"classes/classes.IPFSFileData.html#fileName","classes":"tsd-kind-property tsd-parent-kind-class","parent":"classes.IPFSFileData"},{"id":5,"kind":2048,"name":"toFile","url":"classes/classes.IPFSFileData.html#toFile","classes":"tsd-kind-method tsd-parent-kind-class","parent":"classes.IPFSFileData"},{"id":6,"kind":2048,"name":"toString","url":"classes/classes.IPFSFileData.html#toString","classes":"tsd-kind-method tsd-parent-kind-class","parent":"classes.IPFSFileData"},{"id":7,"kind":2048,"name":"toJSON","url":"classes/classes.IPFSFileData.html#toJSON","classes":"tsd-kind-method tsd-parent-kind-class","parent":"classes.IPFSFileData"},{"id":8,"kind":2048,"name":"toBlob","url":"classes/classes.IPFSFileData.html#toBlob","classes":"tsd-kind-method tsd-parent-kind-class","parent":"classes.IPFSFileData"},{"id":9,"kind":2048,"name":"toObjectURL","url":"classes/classes.IPFSFileData.html#toObjectURL","classes":"tsd-kind-method tsd-parent-kind-class","parent":"classes.IPFSFileData"},{"id":10,"kind":128,"name":"IPFSDecorator","url":"classes/classes.IPFSDecorator.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"classes"},{"id":11,"kind":512,"name":"constructor","url":"classes/classes.IPFSDecorator.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"classes.IPFSDecorator"},{"id":12,"kind":1024,"name":"original","url":"classes/classes.IPFSDecorator.html#original","classes":"tsd-kind-property tsd-parent-kind-class","parent":"classes.IPFSDecorator"},{"id":13,"kind":1024,"name":"files","url":"classes/classes.IPFSDecorator.html#files","classes":"tsd-kind-property tsd-parent-kind-class","parent":"classes.IPFSDecorator"},{"id":14,"kind":1024,"name":"verbose","url":"classes/classes.IPFSDecorator.html#verbose","classes":"tsd-kind-property tsd-parent-kind-class","parent":"classes.IPFSDecorator"},{"id":15,"kind":2048,"name":"ls","url":"classes/classes.IPFSDecorator.html#ls","classes":"tsd-kind-method tsd-parent-kind-class","parent":"classes.IPFSDecorator"},{"id":16,"kind":2048,"name":"read","url":"classes/classes.IPFSDecorator.html#read","classes":"tsd-kind-method tsd-parent-kind-class","parent":"classes.IPFSDecorator"},{"id":17,"kind":2,"name":"context","url":"modules/context.html","classes":"tsd-kind-module"},{"id":18,"kind":2,"name":"hooks","url":"modules/hooks.html","classes":"tsd-kind-module"},{"id":19,"kind":64,"name":"useIPFSFolderState","url":"modules/hooks.html#useIPFSFolderState","classes":"tsd-kind-function tsd-parent-kind-module","parent":"hooks"},{"id":20,"kind":2,"name":"functions","url":"modules/functions.html","classes":"tsd-kind-module"},{"id":21,"kind":2,"name":"types","url":"modules/types.html","classes":"tsd-kind-module"},{"id":22,"kind":4194304,"name":"GlobalIPFSContext","url":"modules/context.html#GlobalIPFSContext","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"context"},{"id":23,"kind":65536,"name":"__type","url":"modules/context.html#GlobalIPFSContext.__type","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"context.GlobalIPFSContext"},{"id":24,"kind":1024,"name":"ipfs","url":"modules/context.html#GlobalIPFSContext.__type.ipfs","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"context.GlobalIPFSContext.__type"},{"id":25,"kind":1024,"name":"isIpfsReady","url":"modules/context.html#GlobalIPFSContext.__type.isIpfsReady","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"context.GlobalIPFSContext.__type"},{"id":26,"kind":32,"name":"MyGlobalContext","url":"modules/context.html#MyGlobalContext","classes":"tsd-kind-variable tsd-parent-kind-module","parent":"context"},{"id":27,"kind":64,"name":"IPFSProvider","url":"modules/context.html#IPFSProvider","classes":"tsd-kind-function tsd-parent-kind-module","parent":"context"},{"id":28,"kind":64,"name":"useIPFS","url":"modules/context.html#useIPFS","classes":"tsd-kind-function tsd-parent-kind-module","parent":"context"},{"id":29,"kind":64,"name":"getMime","url":"modules/functions.html#getMime","classes":"tsd-kind-function tsd-parent-kind-module","parent":"functions"},{"id":30,"kind":64,"name":"getExtension","url":"modules/functions.html#getExtension","classes":"tsd-kind-function tsd-parent-kind-module","parent":"functions"},{"id":31,"kind":4194304,"name":"ipfsInstanceDecorator","url":"modules/types.html#ipfsInstanceDecorator","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"types"},{"id":32,"kind":4194304,"name":"ipfsInstance","url":"modules/types.html#ipfsInstance","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"types"}],"index":{"version":"2.3.9","fields":["name","parent"],"fieldVectors":[["name/0",[0,22.736]],["parent/0",[]],["name/1",[1,31.209]],["parent/1",[0,2.119]],["name/2",[2,26.101]],["parent/2",[3,1.292]],["name/3",[4,31.209]],["parent/3",[3,1.292]],["name/4",[5,31.209]],["parent/4",[3,1.292]],["name/5",[6,31.209]],["parent/5",[3,1.292]],["name/6",[7,31.209]],["parent/6",[3,1.292]],["name/7",[8,31.209]],["parent/7",[3,1.292]],["name/8",[9,31.209]],["parent/8",[3,1.292]],["name/9",[10,31.209]],["parent/9",[3,1.292]],["name/10",[11,31.209]],["parent/10",[0,2.119]],["name/11",[2,26.101]],["parent/11",[12,1.542]],["name/12",[13,31.209]],["parent/12",[12,1.542]],["name/13",[14,31.209]],["parent/13",[12,1.542]],["name/14",[15,31.209]],["parent/14",[12,1.542]],["name/15",[16,31.209]],["parent/15",[12,1.542]],["name/16",[17,31.209]],["parent/16",[12,1.542]],["name/17",[18,18.216]],["parent/17",[]],["name/18",[19,26.101]],["parent/18",[]],["name/19",[20,31.209]],["parent/19",[19,2.432]],["name/20",[21,22.736]],["parent/20",[]],["name/21",[22,22.736]],["parent/21",[]],["name/22",[23,31.209]],["parent/22",[18,1.698]],["name/23",[24,31.209]],["parent/23",[25,2.908]],["name/24",[26,31.209]],["parent/24",[27,2.432]],["name/25",[28,31.209]],["parent/25",[27,2.432]],["name/26",[29,31.209]],["parent/26",[18,1.698]],["name/27",[30,31.209]],["parent/27",[18,1.698]],["name/28",[31,31.209]],["parent/28",[18,1.698]],["name/29",[32,31.209]],["parent/29",[21,2.119]],["name/30",[33,31.209]],["parent/30",[21,2.119]],["name/31",[34,31.209]],["parent/31",[22,2.119]],["name/32",[35,31.209]],["parent/32",[22,2.119]]],"invertedIndex":[["__type",{"_index":24,"name":{"23":{}},"parent":{}}],["classes",{"_index":0,"name":{"0":{}},"parent":{"1":{},"10":{}}}],["classes.ipfsdecorator",{"_index":12,"name":{},"parent":{"11":{},"12":{},"13":{},"14":{},"15":{},"16":{}}}],["classes.ipfsfiledata",{"_index":3,"name":{},"parent":{"2":{},"3":{},"4":{},"5":{},"6":{},"7":{},"8":{},"9":{}}}],["constructor",{"_index":2,"name":{"2":{},"11":{}},"parent":{}}],["content",{"_index":4,"name":{"3":{}},"parent":{}}],["context",{"_index":18,"name":{"17":{}},"parent":{"22":{},"26":{},"27":{},"28":{}}}],["context.globalipfscontext",{"_index":25,"name":{},"parent":{"23":{}}}],["context.globalipfscontext.__type",{"_index":27,"name":{},"parent":{"24":{},"25":{}}}],["filename",{"_index":5,"name":{"4":{}},"parent":{}}],["files",{"_index":14,"name":{"13":{}},"parent":{}}],["functions",{"_index":21,"name":{"20":{}},"parent":{"29":{},"30":{}}}],["getextension",{"_index":33,"name":{"30":{}},"parent":{}}],["getmime",{"_index":32,"name":{"29":{}},"parent":{}}],["globalipfscontext",{"_index":23,"name":{"22":{}},"parent":{}}],["hooks",{"_index":19,"name":{"18":{}},"parent":{"19":{}}}],["ipfs",{"_index":26,"name":{"24":{}},"parent":{}}],["ipfsdecorator",{"_index":11,"name":{"10":{}},"parent":{}}],["ipfsfiledata",{"_index":1,"name":{"1":{}},"parent":{}}],["ipfsinstance",{"_index":35,"name":{"32":{}},"parent":{}}],["ipfsinstancedecorator",{"_index":34,"name":{"31":{}},"parent":{}}],["ipfsprovider",{"_index":30,"name":{"27":{}},"parent":{}}],["isipfsready",{"_index":28,"name":{"25":{}},"parent":{}}],["ls",{"_index":16,"name":{"15":{}},"parent":{}}],["myglobalcontext",{"_index":29,"name":{"26":{}},"parent":{}}],["original",{"_index":13,"name":{"12":{}},"parent":{}}],["read",{"_index":17,"name":{"16":{}},"parent":{}}],["toblob",{"_index":9,"name":{"8":{}},"parent":{}}],["tofile",{"_index":6,"name":{"5":{}},"parent":{}}],["tojson",{"_index":8,"name":{"7":{}},"parent":{}}],["toobjecturl",{"_index":10,"name":{"9":{}},"parent":{}}],["tostring",{"_index":7,"name":{"6":{}},"parent":{}}],["types",{"_index":22,"name":{"21":{}},"parent":{"31":{},"32":{}}}],["useipfs",{"_index":31,"name":{"28":{}},"parent":{}}],["useipfsfolderstate",{"_index":20,"name":{"19":{}},"parent":{}}],["verbose",{"_index":15,"name":{"14":{}},"parent":{}}]],"pipeline":[]}}


--------------------------------------------------------------------------------
/doc/modules/context.html:
--------------------------------------------------------------------------------
1 | <!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>context | react-ipfs</title><meta name="description" content="Documentation for react-ipfs"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">react-ipfs</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">react-ipfs</a></li><li><a href="context.html">context</a></li></ul><h1>Module context</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Type aliases</h3><ul class="tsd-index-list"><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="context.html#GlobalIPFSContext" class="tsd-kind-icon">GlobalIPFSContext</a></li></ul></section><section class="tsd-index-section "><h3>Variables</h3><ul class="tsd-index-list"><li class="tsd-kind-variable tsd-parent-kind-module"><a href="context.html#MyGlobalContext" class="tsd-kind-icon">My<wbr/>Global<wbr/>Context</a></li></ul></section><section class="tsd-index-section "><h3>Functions</h3><ul class="tsd-index-list"><li class="tsd-kind-function tsd-parent-kind-module"><a href="context.html#IPFSProvider" class="tsd-kind-icon">IPFSProvider</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="context.html#useIPFS" class="tsd-kind-icon">useIPFS</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Type aliases</h2><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a name="GlobalIPFSContext" class="tsd-anchor"></a><h3>GlobalIPFSContext</h3><div class="tsd-signature tsd-kind-icon">GlobalIPFSContext<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>ipfs<span class="tsd-signature-symbol">?: </span><a href="../classes/classes.IPFSDecorator.html" class="tsd-signature-type" data-tsd-kind="Class">IPFSDecorator</a><span class="tsd-signature-symbol">; </span>isIpfsReady<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/youaresoroman/react-ipfs/blob/3b5483a/src/context/ipfs.tsx#L8">context/ipfs.tsx:8</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> ipfs<span class="tsd-signature-symbol">?: </span><a href="../classes/classes.IPFSDecorator.html" class="tsd-signature-type" data-tsd-kind="Class">IPFSDecorator</a></h5></li><li class="tsd-parameter"><h5>is<wbr/>Ipfs<wbr/>Ready<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li></ul></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Variables</h2><section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module"><a name="MyGlobalContext" class="tsd-anchor"></a><h3>My<wbr/>Global<wbr/>Context</h3><div class="tsd-signature tsd-kind-icon">My<wbr/>Global<wbr/>Context<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Context</span><span class="tsd-signature-symbol">&lt;</span><a href="context.html#GlobalIPFSContext" class="tsd-signature-type" data-tsd-kind="Type alias">GlobalIPFSContext</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/youaresoroman/react-ipfs/blob/3b5483a/src/context/ipfs.tsx#L12">context/ipfs.tsx:12</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group "><h2>Functions</h2><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a name="IPFSProvider" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> IPFSProvider</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">IPFSProvider<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>children<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ReactChild</span><span class="tsd-signature-symbol">; </span>verbose<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;silent&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;info&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;full&quot;</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Element</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/youaresoroman/react-ipfs/blob/3b5483a/src/context/ipfs.tsx#L16">context/ipfs.tsx:16</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>__namedParameters: <span class="tsd-signature-symbol">{ </span>children<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ReactChild</span><span class="tsd-signature-symbol">; </span>verbose<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;silent&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;info&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;full&quot;</span><span class="tsd-signature-symbol"> }</span></h5><ul class="tsd-parameters"><li class="tsd-parameter"><h5>children<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ReactChild</span></h5></li><li class="tsd-parameter"><h5>verbose<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;silent&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;info&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;full&quot;</span></h5></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Element</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a name="useIPFS" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> useIPFS</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">useIPFS<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="context.html#GlobalIPFSContext" class="tsd-signature-type" data-tsd-kind="Type alias">GlobalIPFSContext</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/youaresoroman/react-ipfs/blob/3b5483a/src/context/ipfs.tsx#L61">context/ipfs.tsx:61</a></li></ul></aside><h4 class="tsd-returns-title">Returns <a href="context.html#GlobalIPFSContext" class="tsd-signature-type" data-tsd-kind="Type alias">GlobalIPFSContext</a></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Modules</a></li><li class=" tsd-kind-module"><a href="classes.html">classes</a></li><li class="current tsd-kind-module"><a href="context.html">context</a></li><li class=" tsd-kind-module"><a href="functions.html">functions</a></li><li class=" tsd-kind-module"><a href="hooks.html">hooks</a></li><li class=" tsd-kind-module"><a href="types.html">types</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="context.html#GlobalIPFSContext" class="tsd-kind-icon">GlobalIPFSContext</a></li><li class="tsd-kind-variable tsd-parent-kind-module"><a href="context.html#MyGlobalContext" class="tsd-kind-icon">My<wbr/>Global<wbr/>Context</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="context.html#IPFSProvider" class="tsd-kind-icon">IPFSProvider</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="context.html#useIPFS" class="tsd-kind-icon">useIPFS</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li><li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li><li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>


--------------------------------------------------------------------------------
/doc/classes/classes.IPFSDecorator.html:
--------------------------------------------------------------------------------
1 | <!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>IPFSDecorator | react-ipfs</title><meta name="description" content="Documentation for react-ipfs"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">react-ipfs</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">react-ipfs</a></li><li><a href="../modules/classes.html">classes</a></li><li><a href="classes.IPFSDecorator.html">IPFSDecorator</a></li></ul><h1>Class IPFSDecorator</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">IPFSDecorator</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="classes.IPFSDecorator.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class"><a href="classes.IPFSDecorator.html#files" class="tsd-kind-icon">files</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="classes.IPFSDecorator.html#original" class="tsd-kind-icon">original</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="classes.IPFSDecorator.html#verbose" class="tsd-kind-icon">verbose</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class"><a href="classes.IPFSDecorator.html#ls" class="tsd-kind-icon">ls</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="classes.IPFSDecorator.html#read" class="tsd-kind-icon">read</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a name="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new IPFSDecorator<span class="tsd-signature-symbol">(</span>ipfs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">IPFS</span>, verbose<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">&quot;silent&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;info&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;full&quot;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="classes.IPFSDecorator.html" class="tsd-signature-type" data-tsd-kind="Class">IPFSDecorator</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/youaresoroman/react-ipfs/blob/3b5483a/src/classes/index.tsx#L50">classes/index.tsx:50</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>ipfs: <span class="tsd-signature-type">IPFS</span></h5></li><li><h5>verbose: <span class="tsd-signature-type">&quot;silent&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;info&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;full&quot;</span><span class="tsd-signature-symbol"> = &quot;info&quot;</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="classes.IPFSDecorator.html" class="tsd-signature-type" data-tsd-kind="Class">IPFSDecorator</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="files" class="tsd-anchor"></a><h3>files</h3><div class="tsd-signature tsd-kind-icon">files<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">API</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/youaresoroman/react-ipfs/blob/3b5483a/src/classes/index.tsx#L47">classes/index.tsx:47</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="original" class="tsd-anchor"></a><h3>original</h3><div class="tsd-signature tsd-kind-icon">original<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">IPFS</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/youaresoroman/react-ipfs/blob/3b5483a/src/classes/index.tsx#L46">classes/index.tsx:46</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="verbose" class="tsd-anchor"></a><h3>verbose</h3><div class="tsd-signature tsd-kind-icon">verbose<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;silent&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;info&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;full&quot;</span><span class="tsd-signature-symbol"> = &quot;info&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/youaresoroman/react-ipfs/blob/3b5483a/src/classes/index.tsx#L48">classes/index.tsx:48</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="ls" class="tsd-anchor"></a><h3>ls</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">ls<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">IPFSEntry</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/youaresoroman/react-ipfs/blob/3b5483a/src/classes/index.tsx#L56">classes/index.tsx:56</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>path: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">IPFSEntry</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="read" class="tsd-anchor"></a><h3>read</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">read<span class="tsd-signature-symbol">(</span>cid<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="classes.IPFSFileData.html" class="tsd-signature-type" data-tsd-kind="Class">IPFSFileData</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/youaresoroman/react-ipfs/blob/3b5483a/src/classes/index.tsx#L78">classes/index.tsx:78</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>cid: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="classes.IPFSFileData.html" class="tsd-signature-type" data-tsd-kind="Class">IPFSFileData</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Modules</a></li><li class="current tsd-kind-module"><a href="../modules/classes.html">classes</a></li><li class=" tsd-kind-module"><a href="../modules/context.html">context</a></li><li class=" tsd-kind-module"><a href="../modules/functions.html">functions</a></li><li class=" tsd-kind-module"><a href="../modules/hooks.html">hooks</a></li><li class=" tsd-kind-module"><a href="../modules/types.html">types</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class tsd-parent-kind-module"><a href="classes.IPFSDecorator.html" class="tsd-kind-icon">IPFSDecorator</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="classes.IPFSDecorator.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="classes.IPFSDecorator.html#files" class="tsd-kind-icon">files</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="classes.IPFSDecorator.html#original" class="tsd-kind-icon">original</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="classes.IPFSDecorator.html#verbose" class="tsd-kind-icon">verbose</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="classes.IPFSDecorator.html#ls" class="tsd-kind-icon">ls</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="classes.IPFSDecorator.html#read" class="tsd-kind-icon">read</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li><li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li><li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>


--------------------------------------------------------------------------------
/doc/classes/classes.IPFSFileData.html:
--------------------------------------------------------------------------------
1 | <!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>IPFSFileData | react-ipfs</title><meta name="description" content="Documentation for react-ipfs"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">react-ipfs</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">react-ipfs</a></li><li><a href="../modules/classes.html">classes</a></li><li><a href="classes.IPFSFileData.html">IPFSFileData</a></li></ul><h1>Class IPFSFileData</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
2 | <p>Class for easy operation with Uin8Array data</p>
3 | </div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">IPFSFileData</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="classes.IPFSFileData.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class"><a href="classes.IPFSFileData.html#content" class="tsd-kind-icon">content</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="classes.IPFSFileData.html#fileName" class="tsd-kind-icon">file<wbr/>Name</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class"><a href="classes.IPFSFileData.html#toBlob" class="tsd-kind-icon">to<wbr/>Blob</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="classes.IPFSFileData.html#toFile" class="tsd-kind-icon">to<wbr/>File</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="classes.IPFSFileData.html#toJSON" class="tsd-kind-icon">toJSON</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="classes.IPFSFileData.html#toObjectURL" class="tsd-kind-icon">to<wbr/>ObjectURL</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="classes.IPFSFileData.html#toString" class="tsd-kind-icon">to<wbr/>String</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a name="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new IPFSFile<wbr/>Data<span class="tsd-signature-symbol">(</span>content<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Uint8Array</span>, fileName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="classes.IPFSFileData.html" class="tsd-signature-type" data-tsd-kind="Class">IPFSFileData</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/youaresoroman/react-ipfs/blob/3b5483a/src/classes/index.tsx#L15">classes/index.tsx:15</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>content: <span class="tsd-signature-type">Uint8Array</span></h5></li><li><h5>fileName: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="classes.IPFSFileData.html" class="tsd-signature-type" data-tsd-kind="Class">IPFSFileData</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="content" class="tsd-anchor"></a><h3>content</h3><div class="tsd-signature tsd-kind-icon">content<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Uint8Array</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/youaresoroman/react-ipfs/blob/3b5483a/src/classes/index.tsx#L12">classes/index.tsx:12</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="fileName" class="tsd-anchor"></a><h3>file<wbr/>Name</h3><div class="tsd-signature tsd-kind-icon">file<wbr/>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/youaresoroman/react-ipfs/blob/3b5483a/src/classes/index.tsx#L13">classes/index.tsx:13</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="toBlob" class="tsd-anchor"></a><h3>to<wbr/>Blob</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">to<wbr/>Blob<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Blob</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/youaresoroman/react-ipfs/blob/3b5483a/src/classes/index.tsx#L36">classes/index.tsx:36</a></li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Blob</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="toFile" class="tsd-anchor"></a><h3>to<wbr/>File</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">to<wbr/>File<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">File</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/youaresoroman/react-ipfs/blob/3b5483a/src/classes/index.tsx#L20">classes/index.tsx:20</a></li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">File</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="toJSON" class="tsd-anchor"></a><h3>toJSON</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">toJSON<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/youaresoroman/react-ipfs/blob/3b5483a/src/classes/index.tsx#L32">classes/index.tsx:32</a></li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="toObjectURL" class="tsd-anchor"></a><h3>to<wbr/>ObjectURL</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">to<wbr/>ObjectURL<span class="tsd-signature-symbol">(</span>blob<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Blob</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">File</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/youaresoroman/react-ipfs/blob/3b5483a/src/classes/index.tsx#L40">classes/index.tsx:40</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> blob: <span class="tsd-signature-type">Blob</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">File</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="toString" class="tsd-anchor"></a><h3>to<wbr/>String</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">to<wbr/>String<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/youaresoroman/react-ipfs/blob/3b5483a/src/classes/index.tsx#L27">classes/index.tsx:27</a></li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Modules</a></li><li class="current tsd-kind-module"><a href="../modules/classes.html">classes</a></li><li class=" tsd-kind-module"><a href="../modules/context.html">context</a></li><li class=" tsd-kind-module"><a href="../modules/functions.html">functions</a></li><li class=" tsd-kind-module"><a href="../modules/hooks.html">hooks</a></li><li class=" tsd-kind-module"><a href="../modules/types.html">types</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class tsd-parent-kind-module"><a href="classes.IPFSFileData.html" class="tsd-kind-icon">IPFSFile<wbr/>Data</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="classes.IPFSFileData.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="classes.IPFSFileData.html#content" class="tsd-kind-icon">content</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="classes.IPFSFileData.html#fileName" class="tsd-kind-icon">file<wbr/>Name</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="classes.IPFSFileData.html#toBlob" class="tsd-kind-icon">to<wbr/>Blob</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="classes.IPFSFileData.html#toFile" class="tsd-kind-icon">to<wbr/>File</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="classes.IPFSFileData.html#toJSON" class="tsd-kind-icon">toJSON</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="classes.IPFSFileData.html#toObjectURL" class="tsd-kind-icon">to<wbr/>ObjectURL</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="classes.IPFSFileData.html#toString" class="tsd-kind-icon">to<wbr/>String</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li><li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li><li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>


--------------------------------------------------------------------------------
/src/hooks/useIPFSFolderState.ts:
--------------------------------------------------------------------------------
  1 | import { useEffect, useState } from "react";
  2 | import { MFSEntry, StatResult } from "ipfs-core-types/src/files";
  3 | import { IPFSFileData } from "../classes/FileData";
  4 | import { concat } from "uint8arrays";
  5 | import { useIPFS } from "./useIPFS";
  6 | 
  7 | export const useIPFSFolderState = (path: string): [
  8 |     string,
  9 |     {
 10 |         ls: (path?: string) => Promise<[MFSEntry[] | null, Error | null | unknown]>,
 11 |         getHash: (path: string) => Promise<[string | null, Error | null]>,
 12 |         read: (path: string) => Promise<[IPFSFileData | null, Error | null]>,
 13 |         write: (fileName: string, content: string | Uint8Array | Blob | AsyncIterable<Uint8Array> | Iterable<Uint8Array>) => Promise<[string | null, Error | null]>,
 14 |         writeAll: (list: { fileName: string, content: string | Uint8Array | Blob | AsyncIterable<Uint8Array> | Iterable<Uint8Array> }[]) => Promise<[boolean, Error | null]>,
 15 |         rm: (path?: string) => Promise<[boolean | null, Error | null]>,
 16 |         mkdir: (pathToMake: string) => Promise<[boolean | null, Error | null]>,
 17 |         mv: (originalPath: string, pathToMove: string) => Promise<[boolean, Error | null]>
 18 |     }
 19 | ] => {
 20 | 
 21 |     const [folderHash, setFolderHash] = useState<string>("");
 22 |     const ipfs = useIPFS();
 23 | 
 24 |     useEffect(() => {
 25 | 
 26 |         if (ipfs) {
 27 |             ipfs.files.stat(path)
 28 |                 .then(async (data: StatResult) => {
 29 |                     if (data) {
 30 |                         if (data.type != "directory") {
 31 |                             throw new Error("Path is a file")
 32 |                         } else {
 33 |                             setFolderHash(data.cid.toString())
 34 |                         }
 35 |                     } else {
 36 |                         throw new Error("Get folder hash error")
 37 |                     }
 38 |                 })
 39 |                 .catch(() => {
 40 |                     if (ipfs) {
 41 |                         ipfs.files.mkdir(path, {
 42 |                             parents: true
 43 |                         })
 44 |                             .then(() => {
 45 |                                 if (ipfs) {
 46 |                                     ipfs.files.stat(path)
 47 |                                         .then(async (data: StatResult) => {
 48 |                                             if (data) {
 49 |                                                 if (data.type != "directory") {
 50 |                                                     throw new Error("Path is a file")
 51 |                                                 } else {
 52 |                                                     setFolderHash(data.cid.toString())
 53 |                                                 }
 54 |                                             } else {
 55 |                                                 throw new Error("Get folder hash error")
 56 |                                             }
 57 |                                         })
 58 |                                         .catch((error: Error) => {
 59 |                                             console.error(error);
 60 |                                         })
 61 |                                 } else {
 62 |                                     console.error("Ipfs instance not started yet");
 63 |                                 }
 64 |                             })
 65 |                             .catch((error: Error) => {
 66 |                                 console.error(error);
 67 |                             })
 68 |                     } else {
 69 |                         console.error("Ipfs instance not started yet");
 70 |                     }
 71 |                 })
 72 |         }
 73 |         return
 74 |     }, [ipfs])
 75 | 
 76 | 
 77 |     const read = async (pathToRead: string): Promise<[IPFSFileData | null, Error | null]> => {
 78 |         return new Promise((resolve) => {
 79 |             const actualPath = `${path}${pathToRead}`
 80 |             if (ipfs) {
 81 |                 ipfs.files.stat(actualPath)
 82 |                     .then(async () => {
 83 |                         if (ipfs) {
 84 |                             const chunks: Uint8Array[] = []
 85 |                             for await (const chunk of ipfs.files.read(actualPath)) {
 86 |                                 chunks.push(chunk)
 87 |                             }
 88 |                             resolve([new IPFSFileData(concat(chunks), actualPath), null])
 89 |                         } else {
 90 |                             resolve([null, new Error("Ipfs instance not started yet")]);
 91 |                         }
 92 |                     })
 93 |                     .catch((error: Error) => {
 94 |                         resolve([null, error]);
 95 |                     })
 96 |             } else {
 97 |                 resolve([null, new Error("Ipfs instance not started yet")]);
 98 |             }
 99 |         })
100 |     }
101 | 
102 |     const getHash = async (pathToRead: string): Promise<[string | null, Error | null]> => {
103 |         return new Promise((resolve) => {
104 |             if (ipfs) {
105 |                 const actualPath = `${path}${pathToRead}`
106 |                 ipfs.files.stat(actualPath)
107 |                     .then(async (data: StatResult) => {
108 |                         if (data) {
109 |                             resolve([data.cid.toString(), null])
110 |                         } else {
111 |                             resolve([null, new Error("Get hash error")])
112 |                         }
113 |                     })
114 |                     .catch((error: Error) => {
115 |                         resolve([null, error]);
116 |                     })
117 |             } else {
118 |                 resolve([null, new Error("Ipfs instance not started yet")]);
119 |             }
120 |         })
121 |     }
122 | 
123 |     const mv = async (originalPath: string, pathToMove: string): Promise<[boolean, Error | null]> => {
124 |         return new Promise((resolve) => {
125 |             if (ipfs) {
126 |                 const actualOriginalPath = `${path}${originalPath}`
127 |                 const actualPathToMove = `${path}${pathToMove}`
128 | 
129 |                 ipfs.files.mv(actualOriginalPath, actualPathToMove, { parents: true })
130 |                     .then(() => {
131 |                         resolve([true, null]);
132 |                     })
133 |                     .catch((error: Error) => {
134 |                         resolve([false, error]);
135 |                     })
136 | 
137 |             } else {
138 |                 resolve([false, new Error("Ipfs instance not started yet")]);
139 |             }
140 |         })
141 |     }
142 | 
143 |     const mkdir = async (pathToMake: string): Promise<[boolean | null, Error | null]> => {
144 |         return new Promise((resolve) => {
145 |             if (ipfs) {
146 |                 const actualPath = `${path}${pathToMake}`
147 |                 ipfs.files.mkdir(actualPath, { parents: true })
148 |                     .then(() => {
149 |                         resolve([true, null]);
150 |                     })
151 |                     .catch((error: Error) => {
152 |                         resolve([false, error]);
153 |                     })
154 |             } else {
155 |                 resolve([null, new Error("Ipfs instance not started yet")]);
156 |             }
157 |         })
158 |     }
159 | 
160 |     const ls = async (pathToList?: string): Promise<[MFSEntry[] | null, Error | null | unknown]> => {
161 |         return new Promise((resolve) => {
162 |             if (ipfs) {
163 |                 (async () => {
164 |                     if (ipfs) {
165 |                         try {
166 |                             const actualPath = `${path}${pathToList ? pathToList : ""}`
167 |                             const list: MFSEntry[] = []
168 |                             for await (const file of ipfs.files.ls(actualPath)) {
169 |                                 list.push(file)
170 |                             }
171 |                             resolve([list, null])
172 |                         } catch (error) {
173 |                             resolve([null, error]);
174 |                         }
175 |                     } else {
176 |                         resolve([null, new Error("Ipfs instance not started yet")]);
177 |                     }
178 |                 })()
179 |             } else {
180 |                 resolve([null, new Error("Ipfs instance not started yet")]);
181 |             }
182 |         })
183 |     }
184 | 
185 |     const write = (fileName: string, content: string | Uint8Array | Blob | AsyncIterable<Uint8Array> | Iterable<Uint8Array>): Promise<[string | null, Error | null]> => {
186 |         return new Promise((resolve) => {
187 |             if (ipfs) {
188 |                 const file = `${path}${fileName}`
189 |                 ipfs.files.stat(path)
190 |                     .then(async () => {
191 |                         rm(file)
192 |                             .then(() => {
193 |                                 if (ipfs) {
194 |                                     ipfs.files.write(file, content, {
195 |                                         parents: true,
196 |                                         create: true
197 |                                     })
198 |                                         .then(() => {
199 |                                             if (ipfs) {
200 |                                                 ipfs.files.stat(path)
201 |                                                     .then(async (data: StatResult) => {
202 |                                                         if (data) {
203 |                                                             setFolderHash(data.cid.toString())
204 |                                                             if (ipfs) {
205 |                                                                 ipfs.files.stat(file)
206 |                                                                     .then(async (data: StatResult) => {
207 |                                                                         if (data) {
208 |                                                                             resolve([data.cid.toString(), null])
209 |                                                                         } else {
210 |                                                                             resolve([null, new Error("Get folder hash error")])
211 |                                                                         }
212 |                                                                     })
213 |                                                                     .catch((error: Error) => {
214 |                                                                         resolve([null, error]);
215 |                                                                     })
216 |                                                             } else {
217 |                                                                 resolve([null, new Error("Get folder hash error")])
218 |                                                             }
219 |                                                             setFolderHash(data?.cid.toString())
220 |                                                         } else {
221 |                                                             resolve([null, new Error("Ipfs instance not started yet")]);
222 |                                                         }
223 |                                                     })
224 |                                                     .catch((error: Error) => {
225 |                                                         resolve([null, error]);
226 |                                                     })
227 |                                             } else {
228 |                                                 resolve([null, new Error("Ipfs instance not started yet")]);
229 |                                             }
230 |                                         })
231 |                                         .catch((error: Error) => {
232 |                                             resolve([null, error]);
233 |                                         })
234 |                                 } else {
235 |                                     resolve([null, new Error("Ipfs instance not started yet")]);
236 |                                 }
237 |                             })
238 | 
239 |                     })
240 |                     .catch((error: Error) => {
241 |                         resolve([null, error]);
242 |                     })
243 |             } else {
244 |                 resolve([null, new Error("Ipfs instance not started yet")]);
245 |             }
246 |         })
247 | 
248 |     }
249 | 
250 |     const writeAll = async (list: { fileName: string, content: string | Uint8Array | Blob | AsyncIterable<Uint8Array> | Iterable<Uint8Array> }[]): Promise<[boolean, Error | null]> => {
251 |         return new Promise((resolve) => {
252 |             if (ipfs) {
253 |                 /* eslint-disable */
254 |                 const promises: any[] = []
255 |                 /* eslint-enable */
256 | 
257 |                 list.forEach(async (data) => {
258 |                     promises.push(new Promise((resolve, reject) => {
259 |                         (async () => {
260 |                             const { fileName, content } = data
261 |                             const [res, error] = await write(fileName, content)
262 |                             res ? resolve(res) : reject(error)
263 |                         })()
264 |                     }))
265 |                 })
266 | 
267 |                 Promise.all(promises)
268 |                     .then(() => {
269 |                         resolve([true, null])
270 |                     })
271 |                     .catch((error) => {
272 |                         resolve([false, error])
273 |                     });
274 |             } else {
275 |                 resolve([false, new Error("Ipfs instance not started yet")]);
276 |             }
277 |         })
278 |     }
279 | 
280 |     const rm = (pathToRemove?: string): Promise<[boolean | null, Error | null]> => {
281 |         return new Promise((resolve) => {
282 |             if (ipfs) {
283 |                 if (pathToRemove) {
284 |                     ipfs.files.rm(`${path}/${pathToRemove}`, { recursive: true })
285 |                         .then(() => {
286 |                             if (ipfs) {
287 |                                 ipfs.files.stat(path)
288 |                                     /* eslint-disable @typescript-eslint/no-explicit-any */
289 |                                     .then(async (data: StatResult) => {
290 |                                         if (data) {
291 |                                             setFolderHash(data.cid.toString())
292 |                                             resolve([true, null])
293 |                                         } else {
294 |                                             resolve([null, new Error("Get folder hash error")])
295 |                                         }
296 |                                     })
297 |                                     .catch((error: Error) => {
298 |                                         resolve([null, error]);
299 |                                     })
300 |                             } else {
301 |                                 resolve([false, new Error("Ipfs instance not started yet")]);
302 |                             }
303 |                         })
304 |                         .catch((error: Error) => {
305 |                             resolve([null, error]);
306 |                         })
307 |                 } else {
308 |                     ipfs.files.rm(path, { recursive: true })
309 |                         .then(() => {
310 |                             if (ipfs) {
311 |                                 ipfs.files.stat(path)
312 |                                     .then(() => {
313 |                                         resolve([null, new Error("Remove Failed")]);
314 |                                     })
315 |                                     .catch(() => {
316 |                                         setFolderHash("")
317 |                                         resolve([true, null])
318 | 
319 |                                     })
320 |                             } else {
321 |                                 resolve([false, new Error("Ipfs instance not started yet")]);
322 |                             }
323 |                         })
324 |                         .catch((error: Error) => {
325 |                             resolve([null, error]);
326 |                         })
327 |                 }
328 |             } else {
329 |                 resolve([null, new Error("Ipfs instance not started yet")]);
330 |             }
331 |         })
332 |     }
333 | 
334 |     return [
335 |         folderHash,
336 |         {
337 |             getHash,
338 |             ls,
339 |             read,
340 |             write,
341 |             writeAll,
342 |             rm,
343 |             mkdir,
344 |             mv
345 |         }
346 |     ]
347 | }


--------------------------------------------------------------------------------
/doc/assets/style.css:
--------------------------------------------------------------------------------
   1 | @import url("./icons.css");
   2 | 
   3 | :root {
   4 |     /* Light */
   5 |     --light-color-background: #fcfcfc;
   6 |     --light-color-secondary-background: #fff;
   7 |     --light-color-text: #222;
   8 |     --light-color-text-aside: #707070;
   9 |     --light-color-link: #4da6ff;
  10 |     --light-color-menu-divider: #eee;
  11 |     --light-color-menu-divider-focus: #000;
  12 |     --light-color-menu-label: #707070;
  13 |     --light-color-panel: var(--light-color-secondary-background);
  14 |     --light-color-panel-divider: #eee;
  15 |     --light-color-comment-tag: #707070;
  16 |     --light-color-comment-tag-text: #fff;
  17 |     --light-color-ts: #9600ff;
  18 |     --light-color-ts-interface: #647f1b;
  19 |     --light-color-ts-enum: #937210;
  20 |     --light-color-ts-class: #0672de;
  21 |     --light-color-ts-private: #707070;
  22 |     --light-color-toolbar: #fff;
  23 |     --light-color-toolbar-text: #333;
  24 |     --light-icon-filter: invert(0);
  25 |     --light-external-icon: url("data:image/svg+xml;utf8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 100 100' width='10' height='10'><path fill-opacity='0' stroke='%23000' stroke-width='10' d='m43,35H5v60h60V57M45,5v10l10,10-30,30 20,20 30-30 10,10h10V5z'/></svg>");
  26 | 
  27 |     /* Dark */
  28 |     --dark-color-background: #36393f;
  29 |     --dark-color-secondary-background: #2f3136;
  30 |     --dark-color-text: #ffffff;
  31 |     --dark-color-text-aside: #e6e4e4;
  32 |     --dark-color-link: #00aff4;
  33 |     --dark-color-menu-divider: #eee;
  34 |     --dark-color-menu-divider-focus: #000;
  35 |     --dark-color-menu-label: #707070;
  36 |     --dark-color-panel: var(--dark-color-secondary-background);
  37 |     --dark-color-panel-divider: #818181;
  38 |     --dark-color-comment-tag: #dcddde;
  39 |     --dark-color-comment-tag-text: #2f3136;
  40 |     --dark-color-ts: #c97dff;
  41 |     --dark-color-ts-interface: #9cbe3c;
  42 |     --dark-color-ts-enum: #d6ab29;
  43 |     --dark-color-ts-class: #3695f3;
  44 |     --dark-color-ts-private: #e2e2e2;
  45 |     --dark-color-toolbar: #34373c;
  46 |     --dark-color-toolbar-text: #ffffff;
  47 |     --dark-icon-filter: invert(1);
  48 |     --dark-external-icon: url("data:image/svg+xml;utf8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 100 100' width='10' height='10'><path fill-opacity='0' stroke='%23fff' stroke-width='10' d='m43,35H5v60h60V57M45,5v10l10,10-30,30 20,20 30-30 10,10h10V5z'/></svg>");
  49 | }
  50 | 
  51 | @media (prefers-color-scheme: light) {
  52 |     :root {
  53 |         --color-background: var(--light-color-background);
  54 |         --color-secondary-background: var(--light-color-secondary-background);
  55 |         --color-text: var(--light-color-text);
  56 |         --color-text-aside: var(--light-color-text-aside);
  57 |         --color-link: var(--light-color-link);
  58 |         --color-menu-divider: var(--light-color-menu-divider);
  59 |         --color-menu-divider-focus: var(--light-color-menu-divider-focus);
  60 |         --color-menu-label: var(--light-color-menu-label);
  61 |         --color-panel: var(--light-color-panel);
  62 |         --color-panel-divider: var(--light-color-panel-divider);
  63 |         --color-comment-tag: var(--light-color-comment-tag);
  64 |         --color-comment-tag-text: var(--light-color-comment-tag-text);
  65 |         --color-ts: var(--light-color-ts);
  66 |         --color-ts-interface: var(--light-color-ts-interface);
  67 |         --color-ts-enum: var(--light-color-ts-enum);
  68 |         --color-ts-class: var(--light-color-ts-class);
  69 |         --color-ts-private: var(--light-color-ts-private);
  70 |         --color-toolbar: var(--light-color-toolbar);
  71 |         --color-toolbar-text: var(--light-color-toolbar-text);
  72 |         --icon-filter: var(--light-icon-filter);
  73 |         --external-icon: var(--light-external-icon);
  74 |     }
  75 | }
  76 | 
  77 | @media (prefers-color-scheme: dark) {
  78 |     :root {
  79 |         --color-background: var(--dark-color-background);
  80 |         --color-secondary-background: var(--dark-color-secondary-background);
  81 |         --color-text: var(--dark-color-text);
  82 |         --color-text-aside: var(--dark-color-text-aside);
  83 |         --color-link: var(--dark-color-link);
  84 |         --color-menu-divider: var(--dark-color-menu-divider);
  85 |         --color-menu-divider-focus: var(--dark-color-menu-divider-focus);
  86 |         --color-menu-label: var(--dark-color-menu-label);
  87 |         --color-panel: var(--dark-color-panel);
  88 |         --color-panel-divider: var(--dark-color-panel-divider);
  89 |         --color-comment-tag: var(--dark-color-comment-tag);
  90 |         --color-comment-tag-text: var(--dark-color-comment-tag-text);
  91 |         --color-ts: var(--dark-color-ts);
  92 |         --color-ts-interface: var(--dark-color-ts-interface);
  93 |         --color-ts-enum: var(--dark-color-ts-enum);
  94 |         --color-ts-class: var(--dark-color-ts-class);
  95 |         --color-ts-private: var(--dark-color-ts-private);
  96 |         --color-toolbar: var(--dark-color-toolbar);
  97 |         --color-toolbar-text: var(--dark-color-toolbar-text);
  98 |         --icon-filter: var(--dark-icon-filter);
  99 |         --external-icon: var(--dark-external-icon);
 100 |     }
 101 | }
 102 | 
 103 | body {
 104 |     margin: 0;
 105 | }
 106 | 
 107 | body.light {
 108 |     --color-background: var(--light-color-background);
 109 |     --color-secondary-background: var(--light-color-secondary-background);
 110 |     --color-text: var(--light-color-text);
 111 |     --color-text-aside: var(--light-color-text-aside);
 112 |     --color-link: var(--light-color-link);
 113 |     --color-menu-divider: var(--light-color-menu-divider);
 114 |     --color-menu-divider-focus: var(--light-color-menu-divider-focus);
 115 |     --color-menu-label: var(--light-color-menu-label);
 116 |     --color-panel: var(--light-color-panel);
 117 |     --color-panel-divider: var(--light-color-panel-divider);
 118 |     --color-comment-tag: var(--light-color-comment-tag);
 119 |     --color-comment-tag-text: var(--light-color-comment-tag-text);
 120 |     --color-ts: var(--light-color-ts);
 121 |     --color-ts-interface: var(--light-color-ts-interface);
 122 |     --color-ts-enum: var(--light-color-ts-enum);
 123 |     --color-ts-class: var(--light-color-ts-class);
 124 |     --color-ts-private: var(--light-color-ts-private);
 125 |     --color-toolbar: var(--light-color-toolbar);
 126 |     --color-toolbar-text: var(--light-color-toolbar-text);
 127 |     --icon-filter: var(--light-icon-filter);
 128 |     --external-icon: var(--light-external-icon);
 129 | }
 130 | 
 131 | body.dark {
 132 |     --color-background: var(--dark-color-background);
 133 |     --color-secondary-background: var(--dark-color-secondary-background);
 134 |     --color-text: var(--dark-color-text);
 135 |     --color-text-aside: var(--dark-color-text-aside);
 136 |     --color-link: var(--dark-color-link);
 137 |     --color-menu-divider: var(--dark-color-menu-divider);
 138 |     --color-menu-divider-focus: var(--dark-color-menu-divider-focus);
 139 |     --color-menu-label: var(--dark-color-menu-label);
 140 |     --color-panel: var(--dark-color-panel);
 141 |     --color-panel-divider: var(--dark-color-panel-divider);
 142 |     --color-comment-tag: var(--dark-color-comment-tag);
 143 |     --color-comment-tag-text: var(--dark-color-comment-tag-text);
 144 |     --color-ts: var(--dark-color-ts);
 145 |     --color-ts-interface: var(--dark-color-ts-interface);
 146 |     --color-ts-enum: var(--dark-color-ts-enum);
 147 |     --color-ts-class: var(--dark-color-ts-class);
 148 |     --color-ts-private: var(--dark-color-ts-private);
 149 |     --color-toolbar: var(--dark-color-toolbar);
 150 |     --color-toolbar-text: var(--dark-color-toolbar-text);
 151 |     --icon-filter: var(--dark-icon-filter);
 152 |     --external-icon: var(--dark-external-icon);
 153 | }
 154 | 
 155 | h1 {
 156 |     font-size: 2em;
 157 |     margin: 0.67em 0;
 158 | }
 159 | 
 160 | h2 {
 161 |     font-size: 1.5em;
 162 |     margin: 0.83em 0;
 163 | }
 164 | 
 165 | h3 {
 166 |     font-size: 1.17em;
 167 |     margin: 1em 0;
 168 | }
 169 | 
 170 | h4,
 171 | .tsd-index-panel h3 {
 172 |     font-size: 1em;
 173 |     margin: 1.33em 0;
 174 | }
 175 | 
 176 | h5 {
 177 |     font-size: 0.83em;
 178 |     margin: 1.67em 0;
 179 | }
 180 | 
 181 | h6 {
 182 |     font-size: 0.67em;
 183 |     margin: 2.33em 0;
 184 | }
 185 | 
 186 | pre {
 187 |     white-space: pre;
 188 |     white-space: pre-wrap;
 189 |     word-wrap: break-word;
 190 | }
 191 | 
 192 | dl,
 193 | menu,
 194 | ol,
 195 | ul {
 196 |     margin: 1em 0;
 197 | }
 198 | 
 199 | dd {
 200 |     margin: 0 0 0 40px;
 201 | }
 202 | 
 203 | .container {
 204 |     max-width: 1200px;
 205 |     margin: 0 auto;
 206 |     padding: 0 40px;
 207 | }
 208 | @media (max-width: 640px) {
 209 |     .container {
 210 |         padding: 0 20px;
 211 |     }
 212 | }
 213 | 
 214 | .container-main {
 215 |     padding-bottom: 200px;
 216 | }
 217 | 
 218 | .row {
 219 |     display: flex;
 220 |     position: relative;
 221 |     margin: 0 -10px;
 222 | }
 223 | .row:after {
 224 |     visibility: hidden;
 225 |     display: block;
 226 |     content: "";
 227 |     clear: both;
 228 |     height: 0;
 229 | }
 230 | 
 231 | .col-4,
 232 | .col-8 {
 233 |     box-sizing: border-box;
 234 |     float: left;
 235 |     padding: 0 10px;
 236 | }
 237 | 
 238 | .col-4 {
 239 |     width: 33.3333333333%;
 240 | }
 241 | .col-8 {
 242 |     width: 66.6666666667%;
 243 | }
 244 | 
 245 | ul.tsd-descriptions > li > :first-child,
 246 | .tsd-panel > :first-child,
 247 | .col-8 > :first-child,
 248 | .col-4 > :first-child,
 249 | ul.tsd-descriptions > li > :first-child > :first-child,
 250 | .tsd-panel > :first-child > :first-child,
 251 | .col-8 > :first-child > :first-child,
 252 | .col-4 > :first-child > :first-child,
 253 | ul.tsd-descriptions > li > :first-child > :first-child > :first-child,
 254 | .tsd-panel > :first-child > :first-child > :first-child,
 255 | .col-8 > :first-child > :first-child > :first-child,
 256 | .col-4 > :first-child > :first-child > :first-child {
 257 |     margin-top: 0;
 258 | }
 259 | ul.tsd-descriptions > li > :last-child,
 260 | .tsd-panel > :last-child,
 261 | .col-8 > :last-child,
 262 | .col-4 > :last-child,
 263 | ul.tsd-descriptions > li > :last-child > :last-child,
 264 | .tsd-panel > :last-child > :last-child,
 265 | .col-8 > :last-child > :last-child,
 266 | .col-4 > :last-child > :last-child,
 267 | ul.tsd-descriptions > li > :last-child > :last-child > :last-child,
 268 | .tsd-panel > :last-child > :last-child > :last-child,
 269 | .col-8 > :last-child > :last-child > :last-child,
 270 | .col-4 > :last-child > :last-child > :last-child {
 271 |     margin-bottom: 0;
 272 | }
 273 | 
 274 | @keyframes fade-in {
 275 |     from {
 276 |         opacity: 0;
 277 |     }
 278 |     to {
 279 |         opacity: 1;
 280 |     }
 281 | }
 282 | @keyframes fade-out {
 283 |     from {
 284 |         opacity: 1;
 285 |         visibility: visible;
 286 |     }
 287 |     to {
 288 |         opacity: 0;
 289 |     }
 290 | }
 291 | @keyframes fade-in-delayed {
 292 |     0% {
 293 |         opacity: 0;
 294 |     }
 295 |     33% {
 296 |         opacity: 0;
 297 |     }
 298 |     100% {
 299 |         opacity: 1;
 300 |     }
 301 | }
 302 | @keyframes fade-out-delayed {
 303 |     0% {
 304 |         opacity: 1;
 305 |         visibility: visible;
 306 |     }
 307 |     66% {
 308 |         opacity: 0;
 309 |     }
 310 |     100% {
 311 |         opacity: 0;
 312 |     }
 313 | }
 314 | @keyframes shift-to-left {
 315 |     from {
 316 |         transform: translate(0, 0);
 317 |     }
 318 |     to {
 319 |         transform: translate(-25%, 0);
 320 |     }
 321 | }
 322 | @keyframes unshift-to-left {
 323 |     from {
 324 |         transform: translate(-25%, 0);
 325 |     }
 326 |     to {
 327 |         transform: translate(0, 0);
 328 |     }
 329 | }
 330 | @keyframes pop-in-from-right {
 331 |     from {
 332 |         transform: translate(100%, 0);
 333 |     }
 334 |     to {
 335 |         transform: translate(0, 0);
 336 |     }
 337 | }
 338 | @keyframes pop-out-to-right {
 339 |     from {
 340 |         transform: translate(0, 0);
 341 |         visibility: visible;
 342 |     }
 343 |     to {
 344 |         transform: translate(100%, 0);
 345 |     }
 346 | }
 347 | body {
 348 |     background: var(--color-background);
 349 |     font-family: "Segoe UI", sans-serif;
 350 |     font-size: 16px;
 351 |     color: var(--color-text);
 352 | }
 353 | 
 354 | a {
 355 |     color: var(--color-link);
 356 |     text-decoration: none;
 357 | }
 358 | a:hover {
 359 |     text-decoration: underline;
 360 | }
 361 | a.external[target="_blank"] {
 362 |     background-image: var(--external-icon);
 363 |     background-position: top 3px right;
 364 |     background-repeat: no-repeat;
 365 |     padding-right: 13px;
 366 | }
 367 | 
 368 | code,
 369 | pre {
 370 |     font-family: Menlo, Monaco, Consolas, "Courier New", monospace;
 371 |     padding: 0.2em;
 372 |     margin: 0;
 373 |     font-size: 14px;
 374 | }
 375 | 
 376 | pre {
 377 |     padding: 10px;
 378 | }
 379 | pre code {
 380 |     padding: 0;
 381 |     font-size: 100%;
 382 | }
 383 | 
 384 | blockquote {
 385 |     margin: 1em 0;
 386 |     padding-left: 1em;
 387 |     border-left: 4px solid gray;
 388 | }
 389 | 
 390 | .tsd-typography {
 391 |     line-height: 1.333em;
 392 | }
 393 | .tsd-typography ul {
 394 |     list-style: square;
 395 |     padding: 0 0 0 20px;
 396 |     margin: 0;
 397 | }
 398 | .tsd-typography h4,
 399 | .tsd-typography .tsd-index-panel h3,
 400 | .tsd-index-panel .tsd-typography h3,
 401 | .tsd-typography h5,
 402 | .tsd-typography h6 {
 403 |     font-size: 1em;
 404 |     margin: 0;
 405 | }
 406 | .tsd-typography h5,
 407 | .tsd-typography h6 {
 408 |     font-weight: normal;
 409 | }
 410 | .tsd-typography p,
 411 | .tsd-typography ul,
 412 | .tsd-typography ol {
 413 |     margin: 1em 0;
 414 | }
 415 | 
 416 | @media (min-width: 901px) and (max-width: 1024px) {
 417 |     html.default .col-content {
 418 |         width: 72%;
 419 |     }
 420 |     html.default .col-menu {
 421 |         width: 28%;
 422 |     }
 423 |     html.default .tsd-navigation {
 424 |         padding-left: 10px;
 425 |     }
 426 | }
 427 | @media (max-width: 900px) {
 428 |     html.default .col-content {
 429 |         float: none;
 430 |         width: 100%;
 431 |     }
 432 |     html.default .col-menu {
 433 |         position: fixed !important;
 434 |         overflow: auto;
 435 |         -webkit-overflow-scrolling: touch;
 436 |         z-index: 1024;
 437 |         top: 0 !important;
 438 |         bottom: 0 !important;
 439 |         left: auto !important;
 440 |         right: 0 !important;
 441 |         width: 100%;
 442 |         padding: 20px 20px 0 0;
 443 |         max-width: 450px;
 444 |         visibility: hidden;
 445 |         background-color: var(--color-panel);
 446 |         transform: translate(100%, 0);
 447 |     }
 448 |     html.default .col-menu > *:last-child {
 449 |         padding-bottom: 20px;
 450 |     }
 451 |     html.default .overlay {
 452 |         content: "";
 453 |         display: block;
 454 |         position: fixed;
 455 |         z-index: 1023;
 456 |         top: 0;
 457 |         left: 0;
 458 |         right: 0;
 459 |         bottom: 0;
 460 |         background-color: rgba(0, 0, 0, 0.75);
 461 |         visibility: hidden;
 462 |     }
 463 | }
 464 | 
 465 | .tsd-page-title {
 466 |     padding: 70px 0 20px 0;
 467 |     margin: 0 0 40px 0;
 468 |     background: var(--color-panel);
 469 |     box-shadow: 0 0 5px rgba(0, 0, 0, 0.35);
 470 | }
 471 | .tsd-page-title h1 {
 472 |     margin: 0;
 473 | }
 474 | 
 475 | .tsd-breadcrumb {
 476 |     margin: 0;
 477 |     padding: 0;
 478 |     color: var(--color-text-aside);
 479 | }
 480 | .tsd-breadcrumb a {
 481 |     color: var(--color-text-aside);
 482 |     text-decoration: none;
 483 | }
 484 | .tsd-breadcrumb a:hover {
 485 |     text-decoration: underline;
 486 | }
 487 | .tsd-breadcrumb li {
 488 |     display: inline;
 489 | }
 490 | .tsd-breadcrumb li:after {
 491 |     content: " / ";
 492 | }
 493 | 
 494 | dl.tsd-comment-tags {
 495 |     overflow: hidden;
 496 | }
 497 | dl.tsd-comment-tags dt {
 498 |     float: left;
 499 |     padding: 1px 5px;
 500 |     margin: 0 10px 0 0;
 501 |     border-radius: 4px;
 502 |     border: 1px solid var(--color-comment-tag);
 503 |     color: var(--color-comment-tag);
 504 |     font-size: 0.8em;
 505 |     font-weight: normal;
 506 | }
 507 | dl.tsd-comment-tags dd {
 508 |     margin: 0 0 10px 0;
 509 | }
 510 | dl.tsd-comment-tags dd:before,
 511 | dl.tsd-comment-tags dd:after {
 512 |     display: table;
 513 |     content: " ";
 514 | }
 515 | dl.tsd-comment-tags dd pre,
 516 | dl.tsd-comment-tags dd:after {
 517 |     clear: both;
 518 | }
 519 | dl.tsd-comment-tags p {
 520 |     margin: 0;
 521 | }
 522 | 
 523 | .tsd-panel.tsd-comment .lead {
 524 |     font-size: 1.1em;
 525 |     line-height: 1.333em;
 526 |     margin-bottom: 2em;
 527 | }
 528 | .tsd-panel.tsd-comment .lead:last-child {
 529 |     margin-bottom: 0;
 530 | }
 531 | 
 532 | .toggle-protected .tsd-is-private {
 533 |     display: none;
 534 | }
 535 | 
 536 | .toggle-public .tsd-is-private,
 537 | .toggle-public .tsd-is-protected,
 538 | .toggle-public .tsd-is-private-protected {
 539 |     display: none;
 540 | }
 541 | 
 542 | .toggle-inherited .tsd-is-inherited {
 543 |     display: none;
 544 | }
 545 | 
 546 | .toggle-externals .tsd-is-external {
 547 |     display: none;
 548 | }
 549 | 
 550 | #tsd-filter {
 551 |     position: relative;
 552 |     display: inline-block;
 553 |     height: 40px;
 554 |     vertical-align: bottom;
 555 | }
 556 | .no-filter #tsd-filter {
 557 |     display: none;
 558 | }
 559 | #tsd-filter .tsd-filter-group {
 560 |     display: inline-block;
 561 |     height: 40px;
 562 |     vertical-align: bottom;
 563 |     white-space: nowrap;
 564 | }
 565 | #tsd-filter input {
 566 |     display: none;
 567 | }
 568 | @media (max-width: 900px) {
 569 |     #tsd-filter .tsd-filter-group {
 570 |         display: block;
 571 |         position: absolute;
 572 |         top: 40px;
 573 |         right: 20px;
 574 |         height: auto;
 575 |         background-color: var(--color-panel);
 576 |         visibility: hidden;
 577 |         transform: translate(50%, 0);
 578 |         box-shadow: 0 0 4px rgba(0, 0, 0, 0.25);
 579 |     }
 580 |     .has-options #tsd-filter .tsd-filter-group {
 581 |         visibility: visible;
 582 |     }
 583 |     .to-has-options #tsd-filter .tsd-filter-group {
 584 |         animation: fade-in 0.2s;
 585 |     }
 586 |     .from-has-options #tsd-filter .tsd-filter-group {
 587 |         animation: fade-out 0.2s;
 588 |     }
 589 |     #tsd-filter label,
 590 |     #tsd-filter .tsd-select {
 591 |         display: block;
 592 |         padding-right: 20px;
 593 |     }
 594 | }
 595 | 
 596 | footer {
 597 |     border-top: 1px solid var(--color-panel-divider);
 598 |     background-color: var(--color-panel);
 599 | }
 600 | footer.with-border-bottom {
 601 |     border-bottom: 1px solid var(--color-panel-divider);
 602 | }
 603 | footer .tsd-legend-group {
 604 |     font-size: 0;
 605 | }
 606 | footer .tsd-legend {
 607 |     display: inline-block;
 608 |     width: 25%;
 609 |     padding: 0;
 610 |     font-size: 16px;
 611 |     list-style: none;
 612 |     line-height: 1.333em;
 613 |     vertical-align: top;
 614 | }
 615 | @media (max-width: 900px) {
 616 |     footer .tsd-legend {
 617 |         width: 50%;
 618 |     }
 619 | }
 620 | 
 621 | .tsd-hierarchy {
 622 |     list-style: square;
 623 |     padding: 0 0 0 20px;
 624 |     margin: 0;
 625 | }
 626 | .tsd-hierarchy .target {
 627 |     font-weight: bold;
 628 | }
 629 | 
 630 | .tsd-index-panel .tsd-index-content {
 631 |     margin-bottom: -30px !important;
 632 | }
 633 | .tsd-index-panel .tsd-index-section {
 634 |     margin-bottom: 30px !important;
 635 | }
 636 | .tsd-index-panel h3 {
 637 |     margin: 0 -20px 10px -20px;
 638 |     padding: 0 20px 10px 20px;
 639 |     border-bottom: 1px solid var(--color-panel-divider);
 640 | }
 641 | .tsd-index-panel ul.tsd-index-list {
 642 |     -webkit-column-count: 3;
 643 |     -moz-column-count: 3;
 644 |     -ms-column-count: 3;
 645 |     -o-column-count: 3;
 646 |     column-count: 3;
 647 |     -webkit-column-gap: 20px;
 648 |     -moz-column-gap: 20px;
 649 |     -ms-column-gap: 20px;
 650 |     -o-column-gap: 20px;
 651 |     column-gap: 20px;
 652 |     padding: 0;
 653 |     list-style: none;
 654 |     line-height: 1.333em;
 655 | }
 656 | @media (max-width: 900px) {
 657 |     .tsd-index-panel ul.tsd-index-list {
 658 |         -webkit-column-count: 1;
 659 |         -moz-column-count: 1;
 660 |         -ms-column-count: 1;
 661 |         -o-column-count: 1;
 662 |         column-count: 1;
 663 |     }
 664 | }
 665 | @media (min-width: 901px) and (max-width: 1024px) {
 666 |     .tsd-index-panel ul.tsd-index-list {
 667 |         -webkit-column-count: 2;
 668 |         -moz-column-count: 2;
 669 |         -ms-column-count: 2;
 670 |         -o-column-count: 2;
 671 |         column-count: 2;
 672 |     }
 673 | }
 674 | .tsd-index-panel ul.tsd-index-list li {
 675 |     -webkit-page-break-inside: avoid;
 676 |     -moz-page-break-inside: avoid;
 677 |     -ms-page-break-inside: avoid;
 678 |     -o-page-break-inside: avoid;
 679 |     page-break-inside: avoid;
 680 | }
 681 | .tsd-index-panel a,
 682 | .tsd-index-panel .tsd-parent-kind-module a {
 683 |     color: var(--color-ts);
 684 | }
 685 | .tsd-index-panel .tsd-parent-kind-interface a {
 686 |     color: var(--color-ts-interface);
 687 | }
 688 | .tsd-index-panel .tsd-parent-kind-enum a {
 689 |     color: var(--color-ts-enum);
 690 | }
 691 | .tsd-index-panel .tsd-parent-kind-class a {
 692 |     color: var(--color-ts-class);
 693 | }
 694 | .tsd-index-panel .tsd-kind-module a {
 695 |     color: var(--color-ts);
 696 | }
 697 | .tsd-index-panel .tsd-kind-interface a {
 698 |     color: var(--color-ts-interface);
 699 | }
 700 | .tsd-index-panel .tsd-kind-enum a {
 701 |     color: var(--color-ts-enum);
 702 | }
 703 | .tsd-index-panel .tsd-kind-class a {
 704 |     color: var(--color-ts-class);
 705 | }
 706 | .tsd-index-panel .tsd-is-private a {
 707 |     color: var(--color-ts-private);
 708 | }
 709 | 
 710 | .tsd-flag {
 711 |     display: inline-block;
 712 |     padding: 1px 5px;
 713 |     border-radius: 4px;
 714 |     color: var(--color-comment-tag-text);
 715 |     background-color: var(--color-comment-tag);
 716 |     text-indent: 0;
 717 |     font-size: 14px;
 718 |     font-weight: normal;
 719 | }
 720 | 
 721 | .tsd-anchor {
 722 |     position: absolute;
 723 |     top: -100px;
 724 | }
 725 | 
 726 | .tsd-member {
 727 |     position: relative;
 728 | }
 729 | .tsd-member .tsd-anchor + h3 {
 730 |     margin-top: 0;
 731 |     margin-bottom: 0;
 732 |     border-bottom: none;
 733 | }
 734 | .tsd-member [data-tsd-kind] {
 735 |     color: var(--color-ts);
 736 | }
 737 | .tsd-member [data-tsd-kind="Interface"] {
 738 |     color: var(--color-ts-interface);
 739 | }
 740 | .tsd-member [data-tsd-kind="Enum"] {
 741 |     color: var(--color-ts-enum);
 742 | }
 743 | .tsd-member [data-tsd-kind="Class"] {
 744 |     color: var(--color-ts-class);
 745 | }
 746 | .tsd-member [data-tsd-kind="Private"] {
 747 |     color: var(--color-ts-private);
 748 | }
 749 | 
 750 | .tsd-navigation {
 751 |     margin: 0 0 0 40px;
 752 | }
 753 | .tsd-navigation a {
 754 |     display: block;
 755 |     padding-top: 2px;
 756 |     padding-bottom: 2px;
 757 |     border-left: 2px solid transparent;
 758 |     color: var(--color-text);
 759 |     text-decoration: none;
 760 |     transition: border-left-color 0.1s;
 761 | }
 762 | .tsd-navigation a:hover {
 763 |     text-decoration: underline;
 764 | }
 765 | .tsd-navigation ul {
 766 |     margin: 0;
 767 |     padding: 0;
 768 |     list-style: none;
 769 | }
 770 | .tsd-navigation li {
 771 |     padding: 0;
 772 | }
 773 | 
 774 | .tsd-navigation.primary {
 775 |     padding-bottom: 40px;
 776 | }
 777 | .tsd-navigation.primary a {
 778 |     display: block;
 779 |     padding-top: 6px;
 780 |     padding-bottom: 6px;
 781 | }
 782 | .tsd-navigation.primary ul li a {
 783 |     padding-left: 5px;
 784 | }
 785 | .tsd-navigation.primary ul li li a {
 786 |     padding-left: 25px;
 787 | }
 788 | .tsd-navigation.primary ul li li li a {
 789 |     padding-left: 45px;
 790 | }
 791 | .tsd-navigation.primary ul li li li li a {
 792 |     padding-left: 65px;
 793 | }
 794 | .tsd-navigation.primary ul li li li li li a {
 795 |     padding-left: 85px;
 796 | }
 797 | .tsd-navigation.primary ul li li li li li li a {
 798 |     padding-left: 105px;
 799 | }
 800 | .tsd-navigation.primary > ul {
 801 |     border-bottom: 1px solid var(--color-panel-divider);
 802 | }
 803 | .tsd-navigation.primary li {
 804 |     border-top: 1px solid var(--color-panel-divider);
 805 | }
 806 | .tsd-navigation.primary li.current > a {
 807 |     font-weight: bold;
 808 | }
 809 | .tsd-navigation.primary li.label span {
 810 |     display: block;
 811 |     padding: 20px 0 6px 5px;
 812 |     color: var(--color-menu-label);
 813 | }
 814 | .tsd-navigation.primary li.globals + li > span,
 815 | .tsd-navigation.primary li.globals + li > a {
 816 |     padding-top: 20px;
 817 | }
 818 | 
 819 | .tsd-navigation.secondary {
 820 |     max-height: calc(100vh - 1rem - 40px);
 821 |     overflow: auto;
 822 |     position: -webkit-sticky;
 823 |     position: sticky;
 824 |     top: calc(0.5rem + 40px);
 825 |     transition: 0.3s;
 826 | }
 827 | .tsd-navigation.secondary.tsd-navigation--toolbar-hide {
 828 |     max-height: calc(100vh - 1rem);
 829 |     top: 0.5rem;
 830 | }
 831 | .tsd-navigation.secondary ul {
 832 |     transition: opacity 0.2s;
 833 | }
 834 | .tsd-navigation.secondary ul li a {
 835 |     padding-left: 25px;
 836 | }
 837 | .tsd-navigation.secondary ul li li a {
 838 |     padding-left: 45px;
 839 | }
 840 | .tsd-navigation.secondary ul li li li a {
 841 |     padding-left: 65px;
 842 | }
 843 | .tsd-navigation.secondary ul li li li li a {
 844 |     padding-left: 85px;
 845 | }
 846 | .tsd-navigation.secondary ul li li li li li a {
 847 |     padding-left: 105px;
 848 | }
 849 | .tsd-navigation.secondary ul li li li li li li a {
 850 |     padding-left: 125px;
 851 | }
 852 | .tsd-navigation.secondary ul.current a {
 853 |     border-left-color: var(--color-panel-divider);
 854 | }
 855 | .tsd-navigation.secondary li.focus > a,
 856 | .tsd-navigation.secondary ul.current li.focus > a {
 857 |     border-left-color: var(--color-menu-divider-focus);
 858 | }
 859 | .tsd-navigation.secondary li.current {
 860 |     margin-top: 20px;
 861 |     margin-bottom: 20px;
 862 |     border-left-color: var(--color-panel-divider);
 863 | }
 864 | .tsd-navigation.secondary li.current > a {
 865 |     font-weight: bold;
 866 | }
 867 | 
 868 | @media (min-width: 901px) {
 869 |     .menu-sticky-wrap {
 870 |         position: static;
 871 |     }
 872 | }
 873 | 
 874 | .tsd-panel {
 875 |     margin: 20px 0;
 876 |     padding: 20px;
 877 |     background-color: var(--color-panel);
 878 |     box-shadow: 0 0 4px rgba(0, 0, 0, 0.25);
 879 | }
 880 | .tsd-panel:empty {
 881 |     display: none;
 882 | }
 883 | .tsd-panel > h1,
 884 | .tsd-panel > h2,
 885 | .tsd-panel > h3 {
 886 |     margin: 1.5em -20px 10px -20px;
 887 |     padding: 0 20px 10px 20px;
 888 |     border-bottom: 1px solid var(--color-panel-divider);
 889 | }
 890 | .tsd-panel > h1.tsd-before-signature,
 891 | .tsd-panel > h2.tsd-before-signature,
 892 | .tsd-panel > h3.tsd-before-signature {
 893 |     margin-bottom: 0;
 894 |     border-bottom: 0;
 895 | }
 896 | .tsd-panel table {
 897 |     display: block;
 898 |     width: 100%;
 899 |     overflow: auto;
 900 |     margin-top: 10px;
 901 |     word-break: normal;
 902 |     word-break: keep-all;
 903 |     border-collapse: collapse;
 904 | }
 905 | .tsd-panel table th {
 906 |     font-weight: bold;
 907 | }
 908 | .tsd-panel table th,
 909 | .tsd-panel table td {
 910 |     padding: 6px 13px;
 911 |     border: 1px solid var(--color-panel-divider);
 912 | }
 913 | .tsd-panel table tr {
 914 |     background: var(--color-background);
 915 | }
 916 | .tsd-panel table tr:nth-child(even) {
 917 |     background: var(--color-secondary-background);
 918 | }
 919 | 
 920 | .tsd-panel-group {
 921 |     margin: 60px 0;
 922 | }
 923 | .tsd-panel-group > h1,
 924 | .tsd-panel-group > h2,
 925 | .tsd-panel-group > h3 {
 926 |     padding-left: 20px;
 927 |     padding-right: 20px;
 928 | }
 929 | 
 930 | #tsd-search {
 931 |     transition: background-color 0.2s;
 932 | }
 933 | #tsd-search .title {
 934 |     position: relative;
 935 |     z-index: 2;
 936 | }
 937 | #tsd-search .field {
 938 |     position: absolute;
 939 |     left: 0;
 940 |     top: 0;
 941 |     right: 40px;
 942 |     height: 40px;
 943 | }
 944 | #tsd-search .field input {
 945 |     box-sizing: border-box;
 946 |     position: relative;
 947 |     top: -50px;
 948 |     z-index: 1;
 949 |     width: 100%;
 950 |     padding: 0 10px;
 951 |     opacity: 0;
 952 |     outline: 0;
 953 |     border: 0;
 954 |     background: transparent;
 955 |     color: var(--color-text);
 956 | }
 957 | #tsd-search .field label {
 958 |     position: absolute;
 959 |     overflow: hidden;
 960 |     right: -40px;
 961 | }
 962 | #tsd-search .field input,
 963 | #tsd-search .title {
 964 |     transition: opacity 0.2s;
 965 | }
 966 | #tsd-search .results {
 967 |     position: absolute;
 968 |     visibility: hidden;
 969 |     top: 40px;
 970 |     width: 100%;
 971 |     margin: 0;
 972 |     padding: 0;
 973 |     list-style: none;
 974 |     box-shadow: 0 0 4px rgba(0, 0, 0, 0.25);
 975 | }
 976 | #tsd-search .results li {
 977 |     padding: 0 10px;
 978 |     background-color: var(--color-background);
 979 | }
 980 | #tsd-search .results li:nth-child(even) {
 981 |     background-color: var(--color-panel);
 982 | }
 983 | #tsd-search .results li.state {
 984 |     display: none;
 985 | }
 986 | #tsd-search .results li.current,
 987 | #tsd-search .results li:hover {
 988 |     background-color: var(--color-panel-divider);
 989 | }
 990 | #tsd-search .results a {
 991 |     display: block;
 992 | }
 993 | #tsd-search .results a:before {
 994 |     top: 10px;
 995 | }
 996 | #tsd-search .results span.parent {
 997 |     color: var(--color-text-aside);
 998 |     font-weight: normal;
 999 | }
1000 | #tsd-search.has-focus {
1001 |     background-color: var(--color-panel-divider);
1002 | }
1003 | #tsd-search.has-focus .field input {
1004 |     top: 0;
1005 |     opacity: 1;
1006 | }
1007 | #tsd-search.has-focus .title {
1008 |     z-index: 0;
1009 |     opacity: 0;
1010 | }
1011 | #tsd-search.has-focus .results {
1012 |     visibility: visible;
1013 | }
1014 | #tsd-search.loading .results li.state.loading {
1015 |     display: block;
1016 | }
1017 | #tsd-search.failure .results li.state.failure {
1018 |     display: block;
1019 | }
1020 | 
1021 | .tsd-signature {
1022 |     margin: 0 0 1em 0;
1023 |     padding: 10px;
1024 |     border: 1px solid var(--color-panel-divider);
1025 |     font-family: Menlo, Monaco, Consolas, "Courier New", monospace;
1026 |     font-size: 14px;
1027 |     overflow-x: auto;
1028 | }
1029 | .tsd-signature.tsd-kind-icon {
1030 |     padding-left: 30px;
1031 | }
1032 | .tsd-signature.tsd-kind-icon:before {
1033 |     top: 10px;
1034 |     left: 10px;
1035 | }
1036 | .tsd-panel > .tsd-signature {
1037 |     margin-left: -20px;
1038 |     margin-right: -20px;
1039 |     border-width: 1px 0;
1040 | }
1041 | .tsd-panel > .tsd-signature.tsd-kind-icon {
1042 |     padding-left: 40px;
1043 | }
1044 | .tsd-panel > .tsd-signature.tsd-kind-icon:before {
1045 |     left: 20px;
1046 | }
1047 | 
1048 | .tsd-signature-symbol {
1049 |     color: var(--color-text-aside);
1050 |     font-weight: normal;
1051 | }
1052 | 
1053 | .tsd-signature-type {
1054 |     font-style: italic;
1055 |     font-weight: normal;
1056 | }
1057 | 
1058 | .tsd-signatures {
1059 |     padding: 0;
1060 |     margin: 0 0 1em 0;
1061 |     border: 1px solid var(--color-panel-divider);
1062 | }
1063 | .tsd-signatures .tsd-signature {
1064 |     margin: 0;
1065 |     border-width: 1px 0 0 0;
1066 |     transition: background-color 0.1s;
1067 | }
1068 | .tsd-signatures .tsd-signature:first-child {
1069 |     border-top-width: 0;
1070 | }
1071 | .tsd-signatures .tsd-signature.current {
1072 |     background-color: var(--color-panel-divider);
1073 | }
1074 | .tsd-signatures.active > .tsd-signature {
1075 |     cursor: pointer;
1076 | }
1077 | .tsd-panel > .tsd-signatures {
1078 |     margin-left: -20px;
1079 |     margin-right: -20px;
1080 |     border-width: 1px 0;
1081 | }
1082 | .tsd-panel > .tsd-signatures .tsd-signature.tsd-kind-icon {
1083 |     padding-left: 40px;
1084 | }
1085 | .tsd-panel > .tsd-signatures .tsd-signature.tsd-kind-icon:before {
1086 |     left: 20px;
1087 | }
1088 | .tsd-panel > a.anchor + .tsd-signatures {
1089 |     border-top-width: 0;
1090 |     margin-top: -20px;
1091 | }
1092 | 
1093 | ul.tsd-descriptions {
1094 |     position: relative;
1095 |     overflow: hidden;
1096 |     padding: 0;
1097 |     list-style: none;
1098 | }
1099 | ul.tsd-descriptions.active > .tsd-description {
1100 |     display: none;
1101 | }
1102 | ul.tsd-descriptions.active > .tsd-description.current {
1103 |     display: block;
1104 | }
1105 | ul.tsd-descriptions.active > .tsd-description.fade-in {
1106 |     animation: fade-in-delayed 0.3s;
1107 | }
1108 | ul.tsd-descriptions.active > .tsd-description.fade-out {
1109 |     animation: fade-out-delayed 0.3s;
1110 |     position: absolute;
1111 |     display: block;
1112 |     top: 0;
1113 |     left: 0;
1114 |     right: 0;
1115 |     opacity: 0;
1116 |     visibility: hidden;
1117 | }
1118 | ul.tsd-descriptions h4,
1119 | ul.tsd-descriptions .tsd-index-panel h3,
1120 | .tsd-index-panel ul.tsd-descriptions h3 {
1121 |     font-size: 16px;
1122 |     margin: 1em 0 0.5em 0;
1123 | }
1124 | 
1125 | ul.tsd-parameters,
1126 | ul.tsd-type-parameters {
1127 |     list-style: square;
1128 |     margin: 0;
1129 |     padding-left: 20px;
1130 | }
1131 | ul.tsd-parameters > li.tsd-parameter-signature,
1132 | ul.tsd-type-parameters > li.tsd-parameter-signature {
1133 |     list-style: none;
1134 |     margin-left: -20px;
1135 | }
1136 | ul.tsd-parameters h5,
1137 | ul.tsd-type-parameters h5 {
1138 |     font-size: 16px;
1139 |     margin: 1em 0 0.5em 0;
1140 | }
1141 | ul.tsd-parameters .tsd-comment,
1142 | ul.tsd-type-parameters .tsd-comment {
1143 |     margin-top: -0.5em;
1144 | }
1145 | 
1146 | .tsd-sources {
1147 |     font-size: 14px;
1148 |     color: var(--color-text-aside);
1149 |     margin: 0 0 1em 0;
1150 | }
1151 | .tsd-sources a {
1152 |     color: var(--color-text-aside);
1153 |     text-decoration: underline;
1154 | }
1155 | .tsd-sources ul,
1156 | .tsd-sources p {
1157 |     margin: 0 !important;
1158 | }
1159 | .tsd-sources ul {
1160 |     list-style: none;
1161 |     padding: 0;
1162 | }
1163 | 
1164 | .tsd-page-toolbar {
1165 |     position: fixed;
1166 |     z-index: 1;
1167 |     top: 0;
1168 |     left: 0;
1169 |     width: 100%;
1170 |     height: 40px;
1171 |     color: var(--color-toolbar-text);
1172 |     background: var(--color-toolbar);
1173 |     border-bottom: 1px solid var(--color-panel-divider);
1174 |     transition: transform 0.3s linear;
1175 | }
1176 | .tsd-page-toolbar a {
1177 |     color: var(--color-toolbar-text);
1178 |     text-decoration: none;
1179 | }
1180 | .tsd-page-toolbar a.title {
1181 |     font-weight: bold;
1182 | }
1183 | .tsd-page-toolbar a.title:hover {
1184 |     text-decoration: underline;
1185 | }
1186 | .tsd-page-toolbar .table-wrap {
1187 |     display: table;
1188 |     width: 100%;
1189 |     height: 40px;
1190 | }
1191 | .tsd-page-toolbar .table-cell {
1192 |     display: table-cell;
1193 |     position: relative;
1194 |     white-space: nowrap;
1195 |     line-height: 40px;
1196 | }
1197 | .tsd-page-toolbar .table-cell:first-child {
1198 |     width: 100%;
1199 | }
1200 | 
1201 | .tsd-page-toolbar--hide {
1202 |     transform: translateY(-100%);
1203 | }
1204 | 
1205 | .tsd-select .tsd-select-list li:before,
1206 | .tsd-select .tsd-select-label:before,
1207 | .tsd-widget:before {
1208 |     content: "";
1209 |     display: inline-block;
1210 |     width: 40px;
1211 |     height: 40px;
1212 |     margin: 0 -8px 0 0;
1213 |     background-image: url(./widgets.png);
1214 |     background-repeat: no-repeat;
1215 |     text-indent: -1024px;
1216 |     vertical-align: bottom;
1217 |     filter: var(--icon-filter);
1218 | }
1219 | @media (-webkit-min-device-pixel-ratio: 1.5), (min-resolution: 144dpi) {
1220 |     .tsd-select .tsd-select-list li:before,
1221 |     .tsd-select .tsd-select-label:before,
1222 |     .tsd-widget:before {
1223 |         background-image: url(./widgets@2x.png);
1224 |         background-size: 320px 40px;
1225 |     }
1226 | }
1227 | 
1228 | .tsd-widget {
1229 |     display: inline-block;
1230 |     overflow: hidden;
1231 |     opacity: 0.8;
1232 |     height: 40px;
1233 |     transition: opacity 0.1s, background-color 0.2s;
1234 |     vertical-align: bottom;
1235 |     cursor: pointer;
1236 | }
1237 | .tsd-widget:hover {
1238 |     opacity: 0.9;
1239 | }
1240 | .tsd-widget.active {
1241 |     opacity: 1;
1242 |     background-color: var(--color-panel-divider);
1243 | }
1244 | .tsd-widget.no-caption {
1245 |     width: 40px;
1246 | }
1247 | .tsd-widget.no-caption:before {
1248 |     margin: 0;
1249 | }
1250 | .tsd-widget.search:before {
1251 |     background-position: 0 0;
1252 | }
1253 | .tsd-widget.menu:before {
1254 |     background-position: -40px 0;
1255 | }
1256 | .tsd-widget.options:before {
1257 |     background-position: -80px 0;
1258 | }
1259 | .tsd-widget.options,
1260 | .tsd-widget.menu {
1261 |     display: none;
1262 | }
1263 | @media (max-width: 900px) {
1264 |     .tsd-widget.options,
1265 |     .tsd-widget.menu {
1266 |         display: inline-block;
1267 |     }
1268 | }
1269 | input[type="checkbox"] + .tsd-widget:before {
1270 |     background-position: -120px 0;
1271 | }
1272 | input[type="checkbox"]:checked + .tsd-widget:before {
1273 |     background-position: -160px 0;
1274 | }
1275 | 
1276 | .tsd-select {
1277 |     position: relative;
1278 |     display: inline-block;
1279 |     height: 40px;
1280 |     transition: opacity 0.1s, background-color 0.2s;
1281 |     vertical-align: bottom;
1282 |     cursor: pointer;
1283 | }
1284 | .tsd-select .tsd-select-label {
1285 |     opacity: 0.6;
1286 |     transition: opacity 0.2s;
1287 | }
1288 | .tsd-select .tsd-select-label:before {
1289 |     background-position: -240px 0;
1290 | }
1291 | .tsd-select.active .tsd-select-label {
1292 |     opacity: 0.8;
1293 | }
1294 | .tsd-select.active .tsd-select-list {
1295 |     visibility: visible;
1296 |     opacity: 1;
1297 |     transition-delay: 0s;
1298 | }
1299 | .tsd-select .tsd-select-list {
1300 |     position: absolute;
1301 |     visibility: hidden;
1302 |     top: 40px;
1303 |     left: 0;
1304 |     margin: 0;
1305 |     padding: 0;
1306 |     opacity: 0;
1307 |     list-style: none;
1308 |     box-shadow: 0 0 4px rgba(0, 0, 0, 0.25);
1309 |     transition: visibility 0s 0.2s, opacity 0.2s;
1310 | }
1311 | .tsd-select .tsd-select-list li {
1312 |     padding: 0 20px 0 0;
1313 |     background-color: var(--color-background);
1314 | }
1315 | .tsd-select .tsd-select-list li:before {
1316 |     background-position: 40px 0;
1317 | }
1318 | .tsd-select .tsd-select-list li:nth-child(even) {
1319 |     background-color: var(--color-panel);
1320 | }
1321 | .tsd-select .tsd-select-list li:hover {
1322 |     background-color: var(--color-panel-divider);
1323 | }
1324 | .tsd-select .tsd-select-list li.selected:before {
1325 |     background-position: -200px 0;
1326 | }
1327 | @media (max-width: 900px) {
1328 |     .tsd-select .tsd-select-list {
1329 |         top: 0;
1330 |         left: auto;
1331 |         right: 100%;
1332 |         margin-right: -5px;
1333 |     }
1334 |     .tsd-select .tsd-select-label:before {
1335 |         background-position: -280px 0;
1336 |     }
1337 | }
1338 | 
1339 | img {
1340 |     max-width: 100%;
1341 | }
1342 | 


--------------------------------------------------------------------------------
/doc/assets/icons.css:
--------------------------------------------------------------------------------
   1 | .tsd-kind-icon {
   2 |     display: block;
   3 |     position: relative;
   4 |     padding-left: 20px;
   5 |     text-indent: -20px;
   6 | }
   7 | .tsd-kind-icon:before {
   8 |     content: "";
   9 |     display: inline-block;
  10 |     vertical-align: middle;
  11 |     width: 17px;
  12 |     height: 17px;
  13 |     margin: 0 3px 2px 0;
  14 |     background-image: url(./icons.png);
  15 | }
  16 | @media (-webkit-min-device-pixel-ratio: 1.5), (min-resolution: 144dpi) {
  17 |     .tsd-kind-icon:before {
  18 |         background-image: url(./icons@2x.png);
  19 |         background-size: 238px 204px;
  20 |     }
  21 | }
  22 | 
  23 | .tsd-signature.tsd-kind-icon:before {
  24 |     background-position: 0 -153px;
  25 | }
  26 | 
  27 | .tsd-kind-object-literal > .tsd-kind-icon:before {
  28 |     background-position: 0px -17px;
  29 | }
  30 | .tsd-kind-object-literal.tsd-is-protected > .tsd-kind-icon:before {
  31 |     background-position: -17px -17px;
  32 | }
  33 | .tsd-kind-object-literal.tsd-is-private > .tsd-kind-icon:before {
  34 |     background-position: -34px -17px;
  35 | }
  36 | 
  37 | .tsd-kind-class > .tsd-kind-icon:before {
  38 |     background-position: 0px -34px;
  39 | }
  40 | .tsd-kind-class.tsd-is-protected > .tsd-kind-icon:before {
  41 |     background-position: -17px -34px;
  42 | }
  43 | .tsd-kind-class.tsd-is-private > .tsd-kind-icon:before {
  44 |     background-position: -34px -34px;
  45 | }
  46 | 
  47 | .tsd-kind-class.tsd-has-type-parameter > .tsd-kind-icon:before {
  48 |     background-position: 0px -51px;
  49 | }
  50 | .tsd-kind-class.tsd-has-type-parameter.tsd-is-protected
  51 |     > .tsd-kind-icon:before {
  52 |     background-position: -17px -51px;
  53 | }
  54 | .tsd-kind-class.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before {
  55 |     background-position: -34px -51px;
  56 | }
  57 | 
  58 | .tsd-kind-interface > .tsd-kind-icon:before {
  59 |     background-position: 0px -68px;
  60 | }
  61 | .tsd-kind-interface.tsd-is-protected > .tsd-kind-icon:before {
  62 |     background-position: -17px -68px;
  63 | }
  64 | .tsd-kind-interface.tsd-is-private > .tsd-kind-icon:before {
  65 |     background-position: -34px -68px;
  66 | }
  67 | 
  68 | .tsd-kind-interface.tsd-has-type-parameter > .tsd-kind-icon:before {
  69 |     background-position: 0px -85px;
  70 | }
  71 | .tsd-kind-interface.tsd-has-type-parameter.tsd-is-protected
  72 |     > .tsd-kind-icon:before {
  73 |     background-position: -17px -85px;
  74 | }
  75 | .tsd-kind-interface.tsd-has-type-parameter.tsd-is-private
  76 |     > .tsd-kind-icon:before {
  77 |     background-position: -34px -85px;
  78 | }
  79 | 
  80 | .tsd-kind-namespace > .tsd-kind-icon:before {
  81 |     background-position: 0px -102px;
  82 | }
  83 | .tsd-kind-namespace.tsd-is-protected > .tsd-kind-icon:before {
  84 |     background-position: -17px -102px;
  85 | }
  86 | .tsd-kind-namespace.tsd-is-private > .tsd-kind-icon:before {
  87 |     background-position: -34px -102px;
  88 | }
  89 | 
  90 | .tsd-kind-module > .tsd-kind-icon:before {
  91 |     background-position: 0px -102px;
  92 | }
  93 | .tsd-kind-module.tsd-is-protected > .tsd-kind-icon:before {
  94 |     background-position: -17px -102px;
  95 | }
  96 | .tsd-kind-module.tsd-is-private > .tsd-kind-icon:before {
  97 |     background-position: -34px -102px;
  98 | }
  99 | 
 100 | .tsd-kind-enum > .tsd-kind-icon:before {
 101 |     background-position: 0px -119px;
 102 | }
 103 | .tsd-kind-enum.tsd-is-protected > .tsd-kind-icon:before {
 104 |     background-position: -17px -119px;
 105 | }
 106 | .tsd-kind-enum.tsd-is-private > .tsd-kind-icon:before {
 107 |     background-position: -34px -119px;
 108 | }
 109 | 
 110 | .tsd-kind-enum-member > .tsd-kind-icon:before {
 111 |     background-position: 0px -136px;
 112 | }
 113 | .tsd-kind-enum-member.tsd-is-protected > .tsd-kind-icon:before {
 114 |     background-position: -17px -136px;
 115 | }
 116 | .tsd-kind-enum-member.tsd-is-private > .tsd-kind-icon:before {
 117 |     background-position: -34px -136px;
 118 | }
 119 | 
 120 | .tsd-kind-signature > .tsd-kind-icon:before {
 121 |     background-position: 0px -153px;
 122 | }
 123 | .tsd-kind-signature.tsd-is-protected > .tsd-kind-icon:before {
 124 |     background-position: -17px -153px;
 125 | }
 126 | .tsd-kind-signature.tsd-is-private > .tsd-kind-icon:before {
 127 |     background-position: -34px -153px;
 128 | }
 129 | 
 130 | .tsd-kind-type-alias > .tsd-kind-icon:before {
 131 |     background-position: 0px -170px;
 132 | }
 133 | .tsd-kind-type-alias.tsd-is-protected > .tsd-kind-icon:before {
 134 |     background-position: -17px -170px;
 135 | }
 136 | .tsd-kind-type-alias.tsd-is-private > .tsd-kind-icon:before {
 137 |     background-position: -34px -170px;
 138 | }
 139 | 
 140 | .tsd-kind-type-alias.tsd-has-type-parameter > .tsd-kind-icon:before {
 141 |     background-position: 0px -187px;
 142 | }
 143 | .tsd-kind-type-alias.tsd-has-type-parameter.tsd-is-protected
 144 |     > .tsd-kind-icon:before {
 145 |     background-position: -17px -187px;
 146 | }
 147 | .tsd-kind-type-alias.tsd-has-type-parameter.tsd-is-private
 148 |     > .tsd-kind-icon:before {
 149 |     background-position: -34px -187px;
 150 | }
 151 | 
 152 | .tsd-kind-variable > .tsd-kind-icon:before {
 153 |     background-position: -136px -0px;
 154 | }
 155 | .tsd-kind-variable.tsd-is-protected > .tsd-kind-icon:before {
 156 |     background-position: -153px -0px;
 157 | }
 158 | .tsd-kind-variable.tsd-is-private > .tsd-kind-icon:before {
 159 |     background-position: -119px -0px;
 160 | }
 161 | .tsd-kind-variable.tsd-parent-kind-class > .tsd-kind-icon:before {
 162 |     background-position: -51px -0px;
 163 | }
 164 | .tsd-kind-variable.tsd-parent-kind-class.tsd-is-inherited
 165 |     > .tsd-kind-icon:before {
 166 |     background-position: -68px -0px;
 167 | }
 168 | .tsd-kind-variable.tsd-parent-kind-class.tsd-is-protected
 169 |     > .tsd-kind-icon:before {
 170 |     background-position: -85px -0px;
 171 | }
 172 | .tsd-kind-variable.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited
 173 |     > .tsd-kind-icon:before {
 174 |     background-position: -102px -0px;
 175 | }
 176 | .tsd-kind-variable.tsd-parent-kind-class.tsd-is-private
 177 |     > .tsd-kind-icon:before {
 178 |     background-position: -119px -0px;
 179 | }
 180 | .tsd-kind-variable.tsd-parent-kind-enum > .tsd-kind-icon:before {
 181 |     background-position: -170px -0px;
 182 | }
 183 | .tsd-kind-variable.tsd-parent-kind-enum.tsd-is-protected
 184 |     > .tsd-kind-icon:before {
 185 |     background-position: -187px -0px;
 186 | }
 187 | .tsd-kind-variable.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before {
 188 |     background-position: -119px -0px;
 189 | }
 190 | .tsd-kind-variable.tsd-parent-kind-interface > .tsd-kind-icon:before {
 191 |     background-position: -204px -0px;
 192 | }
 193 | .tsd-kind-variable.tsd-parent-kind-interface.tsd-is-inherited
 194 |     > .tsd-kind-icon:before {
 195 |     background-position: -221px -0px;
 196 | }
 197 | 
 198 | .tsd-kind-property > .tsd-kind-icon:before {
 199 |     background-position: -136px -0px;
 200 | }
 201 | .tsd-kind-property.tsd-is-protected > .tsd-kind-icon:before {
 202 |     background-position: -153px -0px;
 203 | }
 204 | .tsd-kind-property.tsd-is-private > .tsd-kind-icon:before {
 205 |     background-position: -119px -0px;
 206 | }
 207 | .tsd-kind-property.tsd-parent-kind-class > .tsd-kind-icon:before {
 208 |     background-position: -51px -0px;
 209 | }
 210 | .tsd-kind-property.tsd-parent-kind-class.tsd-is-inherited
 211 |     > .tsd-kind-icon:before {
 212 |     background-position: -68px -0px;
 213 | }
 214 | .tsd-kind-property.tsd-parent-kind-class.tsd-is-protected
 215 |     > .tsd-kind-icon:before {
 216 |     background-position: -85px -0px;
 217 | }
 218 | .tsd-kind-property.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited
 219 |     > .tsd-kind-icon:before {
 220 |     background-position: -102px -0px;
 221 | }
 222 | .tsd-kind-property.tsd-parent-kind-class.tsd-is-private
 223 |     > .tsd-kind-icon:before {
 224 |     background-position: -119px -0px;
 225 | }
 226 | .tsd-kind-property.tsd-parent-kind-enum > .tsd-kind-icon:before {
 227 |     background-position: -170px -0px;
 228 | }
 229 | .tsd-kind-property.tsd-parent-kind-enum.tsd-is-protected
 230 |     > .tsd-kind-icon:before {
 231 |     background-position: -187px -0px;
 232 | }
 233 | .tsd-kind-property.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before {
 234 |     background-position: -119px -0px;
 235 | }
 236 | .tsd-kind-property.tsd-parent-kind-interface > .tsd-kind-icon:before {
 237 |     background-position: -204px -0px;
 238 | }
 239 | .tsd-kind-property.tsd-parent-kind-interface.tsd-is-inherited
 240 |     > .tsd-kind-icon:before {
 241 |     background-position: -221px -0px;
 242 | }
 243 | 
 244 | .tsd-kind-get-signature > .tsd-kind-icon:before {
 245 |     background-position: -136px -17px;
 246 | }
 247 | .tsd-kind-get-signature.tsd-is-protected > .tsd-kind-icon:before {
 248 |     background-position: -153px -17px;
 249 | }
 250 | .tsd-kind-get-signature.tsd-is-private > .tsd-kind-icon:before {
 251 |     background-position: -119px -17px;
 252 | }
 253 | .tsd-kind-get-signature.tsd-parent-kind-class > .tsd-kind-icon:before {
 254 |     background-position: -51px -17px;
 255 | }
 256 | .tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-inherited
 257 |     > .tsd-kind-icon:before {
 258 |     background-position: -68px -17px;
 259 | }
 260 | .tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-protected
 261 |     > .tsd-kind-icon:before {
 262 |     background-position: -85px -17px;
 263 | }
 264 | .tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited
 265 |     > .tsd-kind-icon:before {
 266 |     background-position: -102px -17px;
 267 | }
 268 | .tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-private
 269 |     > .tsd-kind-icon:before {
 270 |     background-position: -119px -17px;
 271 | }
 272 | .tsd-kind-get-signature.tsd-parent-kind-enum > .tsd-kind-icon:before {
 273 |     background-position: -170px -17px;
 274 | }
 275 | .tsd-kind-get-signature.tsd-parent-kind-enum.tsd-is-protected
 276 |     > .tsd-kind-icon:before {
 277 |     background-position: -187px -17px;
 278 | }
 279 | .tsd-kind-get-signature.tsd-parent-kind-enum.tsd-is-private
 280 |     > .tsd-kind-icon:before {
 281 |     background-position: -119px -17px;
 282 | }
 283 | .tsd-kind-get-signature.tsd-parent-kind-interface > .tsd-kind-icon:before {
 284 |     background-position: -204px -17px;
 285 | }
 286 | .tsd-kind-get-signature.tsd-parent-kind-interface.tsd-is-inherited
 287 |     > .tsd-kind-icon:before {
 288 |     background-position: -221px -17px;
 289 | }
 290 | 
 291 | .tsd-kind-set-signature > .tsd-kind-icon:before {
 292 |     background-position: -136px -34px;
 293 | }
 294 | .tsd-kind-set-signature.tsd-is-protected > .tsd-kind-icon:before {
 295 |     background-position: -153px -34px;
 296 | }
 297 | .tsd-kind-set-signature.tsd-is-private > .tsd-kind-icon:before {
 298 |     background-position: -119px -34px;
 299 | }
 300 | .tsd-kind-set-signature.tsd-parent-kind-class > .tsd-kind-icon:before {
 301 |     background-position: -51px -34px;
 302 | }
 303 | .tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-inherited
 304 |     > .tsd-kind-icon:before {
 305 |     background-position: -68px -34px;
 306 | }
 307 | .tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-protected
 308 |     > .tsd-kind-icon:before {
 309 |     background-position: -85px -34px;
 310 | }
 311 | .tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited
 312 |     > .tsd-kind-icon:before {
 313 |     background-position: -102px -34px;
 314 | }
 315 | .tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-private
 316 |     > .tsd-kind-icon:before {
 317 |     background-position: -119px -34px;
 318 | }
 319 | .tsd-kind-set-signature.tsd-parent-kind-enum > .tsd-kind-icon:before {
 320 |     background-position: -170px -34px;
 321 | }
 322 | .tsd-kind-set-signature.tsd-parent-kind-enum.tsd-is-protected
 323 |     > .tsd-kind-icon:before {
 324 |     background-position: -187px -34px;
 325 | }
 326 | .tsd-kind-set-signature.tsd-parent-kind-enum.tsd-is-private
 327 |     > .tsd-kind-icon:before {
 328 |     background-position: -119px -34px;
 329 | }
 330 | .tsd-kind-set-signature.tsd-parent-kind-interface > .tsd-kind-icon:before {
 331 |     background-position: -204px -34px;
 332 | }
 333 | .tsd-kind-set-signature.tsd-parent-kind-interface.tsd-is-inherited
 334 |     > .tsd-kind-icon:before {
 335 |     background-position: -221px -34px;
 336 | }
 337 | 
 338 | .tsd-kind-accessor > .tsd-kind-icon:before {
 339 |     background-position: -136px -51px;
 340 | }
 341 | .tsd-kind-accessor.tsd-is-protected > .tsd-kind-icon:before {
 342 |     background-position: -153px -51px;
 343 | }
 344 | .tsd-kind-accessor.tsd-is-private > .tsd-kind-icon:before {
 345 |     background-position: -119px -51px;
 346 | }
 347 | .tsd-kind-accessor.tsd-parent-kind-class > .tsd-kind-icon:before {
 348 |     background-position: -51px -51px;
 349 | }
 350 | .tsd-kind-accessor.tsd-parent-kind-class.tsd-is-inherited
 351 |     > .tsd-kind-icon:before {
 352 |     background-position: -68px -51px;
 353 | }
 354 | .tsd-kind-accessor.tsd-parent-kind-class.tsd-is-protected
 355 |     > .tsd-kind-icon:before {
 356 |     background-position: -85px -51px;
 357 | }
 358 | .tsd-kind-accessor.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited
 359 |     > .tsd-kind-icon:before {
 360 |     background-position: -102px -51px;
 361 | }
 362 | .tsd-kind-accessor.tsd-parent-kind-class.tsd-is-private
 363 |     > .tsd-kind-icon:before {
 364 |     background-position: -119px -51px;
 365 | }
 366 | .tsd-kind-accessor.tsd-parent-kind-enum > .tsd-kind-icon:before {
 367 |     background-position: -170px -51px;
 368 | }
 369 | .tsd-kind-accessor.tsd-parent-kind-enum.tsd-is-protected
 370 |     > .tsd-kind-icon:before {
 371 |     background-position: -187px -51px;
 372 | }
 373 | .tsd-kind-accessor.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before {
 374 |     background-position: -119px -51px;
 375 | }
 376 | .tsd-kind-accessor.tsd-parent-kind-interface > .tsd-kind-icon:before {
 377 |     background-position: -204px -51px;
 378 | }
 379 | .tsd-kind-accessor.tsd-parent-kind-interface.tsd-is-inherited
 380 |     > .tsd-kind-icon:before {
 381 |     background-position: -221px -51px;
 382 | }
 383 | 
 384 | .tsd-kind-function > .tsd-kind-icon:before {
 385 |     background-position: -136px -68px;
 386 | }
 387 | .tsd-kind-function.tsd-is-protected > .tsd-kind-icon:before {
 388 |     background-position: -153px -68px;
 389 | }
 390 | .tsd-kind-function.tsd-is-private > .tsd-kind-icon:before {
 391 |     background-position: -119px -68px;
 392 | }
 393 | .tsd-kind-function.tsd-parent-kind-class > .tsd-kind-icon:before {
 394 |     background-position: -51px -68px;
 395 | }
 396 | .tsd-kind-function.tsd-parent-kind-class.tsd-is-inherited
 397 |     > .tsd-kind-icon:before {
 398 |     background-position: -68px -68px;
 399 | }
 400 | .tsd-kind-function.tsd-parent-kind-class.tsd-is-protected
 401 |     > .tsd-kind-icon:before {
 402 |     background-position: -85px -68px;
 403 | }
 404 | .tsd-kind-function.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited
 405 |     > .tsd-kind-icon:before {
 406 |     background-position: -102px -68px;
 407 | }
 408 | .tsd-kind-function.tsd-parent-kind-class.tsd-is-private
 409 |     > .tsd-kind-icon:before {
 410 |     background-position: -119px -68px;
 411 | }
 412 | .tsd-kind-function.tsd-parent-kind-enum > .tsd-kind-icon:before {
 413 |     background-position: -170px -68px;
 414 | }
 415 | .tsd-kind-function.tsd-parent-kind-enum.tsd-is-protected
 416 |     > .tsd-kind-icon:before {
 417 |     background-position: -187px -68px;
 418 | }
 419 | .tsd-kind-function.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before {
 420 |     background-position: -119px -68px;
 421 | }
 422 | .tsd-kind-function.tsd-parent-kind-interface > .tsd-kind-icon:before {
 423 |     background-position: -204px -68px;
 424 | }
 425 | .tsd-kind-function.tsd-parent-kind-interface.tsd-is-inherited
 426 |     > .tsd-kind-icon:before {
 427 |     background-position: -221px -68px;
 428 | }
 429 | 
 430 | .tsd-kind-method > .tsd-kind-icon:before {
 431 |     background-position: -136px -68px;
 432 | }
 433 | .tsd-kind-method.tsd-is-protected > .tsd-kind-icon:before {
 434 |     background-position: -153px -68px;
 435 | }
 436 | .tsd-kind-method.tsd-is-private > .tsd-kind-icon:before {
 437 |     background-position: -119px -68px;
 438 | }
 439 | .tsd-kind-method.tsd-parent-kind-class > .tsd-kind-icon:before {
 440 |     background-position: -51px -68px;
 441 | }
 442 | .tsd-kind-method.tsd-parent-kind-class.tsd-is-inherited
 443 |     > .tsd-kind-icon:before {
 444 |     background-position: -68px -68px;
 445 | }
 446 | .tsd-kind-method.tsd-parent-kind-class.tsd-is-protected
 447 |     > .tsd-kind-icon:before {
 448 |     background-position: -85px -68px;
 449 | }
 450 | .tsd-kind-method.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited
 451 |     > .tsd-kind-icon:before {
 452 |     background-position: -102px -68px;
 453 | }
 454 | .tsd-kind-method.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before {
 455 |     background-position: -119px -68px;
 456 | }
 457 | .tsd-kind-method.tsd-parent-kind-enum > .tsd-kind-icon:before {
 458 |     background-position: -170px -68px;
 459 | }
 460 | .tsd-kind-method.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before {
 461 |     background-position: -187px -68px;
 462 | }
 463 | .tsd-kind-method.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before {
 464 |     background-position: -119px -68px;
 465 | }
 466 | .tsd-kind-method.tsd-parent-kind-interface > .tsd-kind-icon:before {
 467 |     background-position: -204px -68px;
 468 | }
 469 | .tsd-kind-method.tsd-parent-kind-interface.tsd-is-inherited
 470 |     > .tsd-kind-icon:before {
 471 |     background-position: -221px -68px;
 472 | }
 473 | 
 474 | .tsd-kind-call-signature > .tsd-kind-icon:before {
 475 |     background-position: -136px -68px;
 476 | }
 477 | .tsd-kind-call-signature.tsd-is-protected > .tsd-kind-icon:before {
 478 |     background-position: -153px -68px;
 479 | }
 480 | .tsd-kind-call-signature.tsd-is-private > .tsd-kind-icon:before {
 481 |     background-position: -119px -68px;
 482 | }
 483 | .tsd-kind-call-signature.tsd-parent-kind-class > .tsd-kind-icon:before {
 484 |     background-position: -51px -68px;
 485 | }
 486 | .tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-inherited
 487 |     > .tsd-kind-icon:before {
 488 |     background-position: -68px -68px;
 489 | }
 490 | .tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected
 491 |     > .tsd-kind-icon:before {
 492 |     background-position: -85px -68px;
 493 | }
 494 | .tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited
 495 |     > .tsd-kind-icon:before {
 496 |     background-position: -102px -68px;
 497 | }
 498 | .tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-private
 499 |     > .tsd-kind-icon:before {
 500 |     background-position: -119px -68px;
 501 | }
 502 | .tsd-kind-call-signature.tsd-parent-kind-enum > .tsd-kind-icon:before {
 503 |     background-position: -170px -68px;
 504 | }
 505 | .tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-protected
 506 |     > .tsd-kind-icon:before {
 507 |     background-position: -187px -68px;
 508 | }
 509 | .tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-private
 510 |     > .tsd-kind-icon:before {
 511 |     background-position: -119px -68px;
 512 | }
 513 | .tsd-kind-call-signature.tsd-parent-kind-interface > .tsd-kind-icon:before {
 514 |     background-position: -204px -68px;
 515 | }
 516 | .tsd-kind-call-signature.tsd-parent-kind-interface.tsd-is-inherited
 517 |     > .tsd-kind-icon:before {
 518 |     background-position: -221px -68px;
 519 | }
 520 | 
 521 | .tsd-kind-function.tsd-has-type-parameter > .tsd-kind-icon:before {
 522 |     background-position: -136px -85px;
 523 | }
 524 | .tsd-kind-function.tsd-has-type-parameter.tsd-is-protected
 525 |     > .tsd-kind-icon:before {
 526 |     background-position: -153px -85px;
 527 | }
 528 | .tsd-kind-function.tsd-has-type-parameter.tsd-is-private
 529 |     > .tsd-kind-icon:before {
 530 |     background-position: -119px -85px;
 531 | }
 532 | .tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class
 533 |     > .tsd-kind-icon:before {
 534 |     background-position: -51px -85px;
 535 | }
 536 | .tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-inherited
 537 |     > .tsd-kind-icon:before {
 538 |     background-position: -68px -85px;
 539 | }
 540 | .tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected
 541 |     > .tsd-kind-icon:before {
 542 |     background-position: -85px -85px;
 543 | }
 544 | .tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited
 545 |     > .tsd-kind-icon:before {
 546 |     background-position: -102px -85px;
 547 | }
 548 | .tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-private
 549 |     > .tsd-kind-icon:before {
 550 |     background-position: -119px -85px;
 551 | }
 552 | .tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum
 553 |     > .tsd-kind-icon:before {
 554 |     background-position: -170px -85px;
 555 | }
 556 | .tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-protected
 557 |     > .tsd-kind-icon:before {
 558 |     background-position: -187px -85px;
 559 | }
 560 | .tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-private
 561 |     > .tsd-kind-icon:before {
 562 |     background-position: -119px -85px;
 563 | }
 564 | .tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-interface
 565 |     > .tsd-kind-icon:before {
 566 |     background-position: -204px -85px;
 567 | }
 568 | .tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-interface.tsd-is-inherited
 569 |     > .tsd-kind-icon:before {
 570 |     background-position: -221px -85px;
 571 | }
 572 | 
 573 | .tsd-kind-method.tsd-has-type-parameter > .tsd-kind-icon:before {
 574 |     background-position: -136px -85px;
 575 | }
 576 | .tsd-kind-method.tsd-has-type-parameter.tsd-is-protected
 577 |     > .tsd-kind-icon:before {
 578 |     background-position: -153px -85px;
 579 | }
 580 | .tsd-kind-method.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before {
 581 |     background-position: -119px -85px;
 582 | }
 583 | .tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class
 584 |     > .tsd-kind-icon:before {
 585 |     background-position: -51px -85px;
 586 | }
 587 | .tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-inherited
 588 |     > .tsd-kind-icon:before {
 589 |     background-position: -68px -85px;
 590 | }
 591 | .tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected
 592 |     > .tsd-kind-icon:before {
 593 |     background-position: -85px -85px;
 594 | }
 595 | .tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited
 596 |     > .tsd-kind-icon:before {
 597 |     background-position: -102px -85px;
 598 | }
 599 | .tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-private
 600 |     > .tsd-kind-icon:before {
 601 |     background-position: -119px -85px;
 602 | }
 603 | .tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum
 604 |     > .tsd-kind-icon:before {
 605 |     background-position: -170px -85px;
 606 | }
 607 | .tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-protected
 608 |     > .tsd-kind-icon:before {
 609 |     background-position: -187px -85px;
 610 | }
 611 | .tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-private
 612 |     > .tsd-kind-icon:before {
 613 |     background-position: -119px -85px;
 614 | }
 615 | .tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-interface
 616 |     > .tsd-kind-icon:before {
 617 |     background-position: -204px -85px;
 618 | }
 619 | .tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-interface.tsd-is-inherited
 620 |     > .tsd-kind-icon:before {
 621 |     background-position: -221px -85px;
 622 | }
 623 | 
 624 | .tsd-kind-constructor > .tsd-kind-icon:before {
 625 |     background-position: -136px -102px;
 626 | }
 627 | .tsd-kind-constructor.tsd-is-protected > .tsd-kind-icon:before {
 628 |     background-position: -153px -102px;
 629 | }
 630 | .tsd-kind-constructor.tsd-is-private > .tsd-kind-icon:before {
 631 |     background-position: -119px -102px;
 632 | }
 633 | .tsd-kind-constructor.tsd-parent-kind-class > .tsd-kind-icon:before {
 634 |     background-position: -51px -102px;
 635 | }
 636 | .tsd-kind-constructor.tsd-parent-kind-class.tsd-is-inherited
 637 |     > .tsd-kind-icon:before {
 638 |     background-position: -68px -102px;
 639 | }
 640 | .tsd-kind-constructor.tsd-parent-kind-class.tsd-is-protected
 641 |     > .tsd-kind-icon:before {
 642 |     background-position: -85px -102px;
 643 | }
 644 | .tsd-kind-constructor.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited
 645 |     > .tsd-kind-icon:before {
 646 |     background-position: -102px -102px;
 647 | }
 648 | .tsd-kind-constructor.tsd-parent-kind-class.tsd-is-private
 649 |     > .tsd-kind-icon:before {
 650 |     background-position: -119px -102px;
 651 | }
 652 | .tsd-kind-constructor.tsd-parent-kind-enum > .tsd-kind-icon:before {
 653 |     background-position: -170px -102px;
 654 | }
 655 | .tsd-kind-constructor.tsd-parent-kind-enum.tsd-is-protected
 656 |     > .tsd-kind-icon:before {
 657 |     background-position: -187px -102px;
 658 | }
 659 | .tsd-kind-constructor.tsd-parent-kind-enum.tsd-is-private
 660 |     > .tsd-kind-icon:before {
 661 |     background-position: -119px -102px;
 662 | }
 663 | .tsd-kind-constructor.tsd-parent-kind-interface > .tsd-kind-icon:before {
 664 |     background-position: -204px -102px;
 665 | }
 666 | .tsd-kind-constructor.tsd-parent-kind-interface.tsd-is-inherited
 667 |     > .tsd-kind-icon:before {
 668 |     background-position: -221px -102px;
 669 | }
 670 | 
 671 | .tsd-kind-constructor-signature > .tsd-kind-icon:before {
 672 |     background-position: -136px -102px;
 673 | }
 674 | .tsd-kind-constructor-signature.tsd-is-protected > .tsd-kind-icon:before {
 675 |     background-position: -153px -102px;
 676 | }
 677 | .tsd-kind-constructor-signature.tsd-is-private > .tsd-kind-icon:before {
 678 |     background-position: -119px -102px;
 679 | }
 680 | .tsd-kind-constructor-signature.tsd-parent-kind-class > .tsd-kind-icon:before {
 681 |     background-position: -51px -102px;
 682 | }
 683 | .tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-inherited
 684 |     > .tsd-kind-icon:before {
 685 |     background-position: -68px -102px;
 686 | }
 687 | .tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-protected
 688 |     > .tsd-kind-icon:before {
 689 |     background-position: -85px -102px;
 690 | }
 691 | .tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited
 692 |     > .tsd-kind-icon:before {
 693 |     background-position: -102px -102px;
 694 | }
 695 | .tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-private
 696 |     > .tsd-kind-icon:before {
 697 |     background-position: -119px -102px;
 698 | }
 699 | .tsd-kind-constructor-signature.tsd-parent-kind-enum > .tsd-kind-icon:before {
 700 |     background-position: -170px -102px;
 701 | }
 702 | .tsd-kind-constructor-signature.tsd-parent-kind-enum.tsd-is-protected
 703 |     > .tsd-kind-icon:before {
 704 |     background-position: -187px -102px;
 705 | }
 706 | .tsd-kind-constructor-signature.tsd-parent-kind-enum.tsd-is-private
 707 |     > .tsd-kind-icon:before {
 708 |     background-position: -119px -102px;
 709 | }
 710 | .tsd-kind-constructor-signature.tsd-parent-kind-interface
 711 |     > .tsd-kind-icon:before {
 712 |     background-position: -204px -102px;
 713 | }
 714 | .tsd-kind-constructor-signature.tsd-parent-kind-interface.tsd-is-inherited
 715 |     > .tsd-kind-icon:before {
 716 |     background-position: -221px -102px;
 717 | }
 718 | 
 719 | .tsd-kind-index-signature > .tsd-kind-icon:before {
 720 |     background-position: -136px -119px;
 721 | }
 722 | .tsd-kind-index-signature.tsd-is-protected > .tsd-kind-icon:before {
 723 |     background-position: -153px -119px;
 724 | }
 725 | .tsd-kind-index-signature.tsd-is-private > .tsd-kind-icon:before {
 726 |     background-position: -119px -119px;
 727 | }
 728 | .tsd-kind-index-signature.tsd-parent-kind-class > .tsd-kind-icon:before {
 729 |     background-position: -51px -119px;
 730 | }
 731 | .tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-inherited
 732 |     > .tsd-kind-icon:before {
 733 |     background-position: -68px -119px;
 734 | }
 735 | .tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-protected
 736 |     > .tsd-kind-icon:before {
 737 |     background-position: -85px -119px;
 738 | }
 739 | .tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited
 740 |     > .tsd-kind-icon:before {
 741 |     background-position: -102px -119px;
 742 | }
 743 | .tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-private
 744 |     > .tsd-kind-icon:before {
 745 |     background-position: -119px -119px;
 746 | }
 747 | .tsd-kind-index-signature.tsd-parent-kind-enum > .tsd-kind-icon:before {
 748 |     background-position: -170px -119px;
 749 | }
 750 | .tsd-kind-index-signature.tsd-parent-kind-enum.tsd-is-protected
 751 |     > .tsd-kind-icon:before {
 752 |     background-position: -187px -119px;
 753 | }
 754 | .tsd-kind-index-signature.tsd-parent-kind-enum.tsd-is-private
 755 |     > .tsd-kind-icon:before {
 756 |     background-position: -119px -119px;
 757 | }
 758 | .tsd-kind-index-signature.tsd-parent-kind-interface > .tsd-kind-icon:before {
 759 |     background-position: -204px -119px;
 760 | }
 761 | .tsd-kind-index-signature.tsd-parent-kind-interface.tsd-is-inherited
 762 |     > .tsd-kind-icon:before {
 763 |     background-position: -221px -119px;
 764 | }
 765 | 
 766 | .tsd-kind-event > .tsd-kind-icon:before {
 767 |     background-position: -136px -136px;
 768 | }
 769 | .tsd-kind-event.tsd-is-protected > .tsd-kind-icon:before {
 770 |     background-position: -153px -136px;
 771 | }
 772 | .tsd-kind-event.tsd-is-private > .tsd-kind-icon:before {
 773 |     background-position: -119px -136px;
 774 | }
 775 | .tsd-kind-event.tsd-parent-kind-class > .tsd-kind-icon:before {
 776 |     background-position: -51px -136px;
 777 | }
 778 | .tsd-kind-event.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before {
 779 |     background-position: -68px -136px;
 780 | }
 781 | .tsd-kind-event.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before {
 782 |     background-position: -85px -136px;
 783 | }
 784 | .tsd-kind-event.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited
 785 |     > .tsd-kind-icon:before {
 786 |     background-position: -102px -136px;
 787 | }
 788 | .tsd-kind-event.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before {
 789 |     background-position: -119px -136px;
 790 | }
 791 | .tsd-kind-event.tsd-parent-kind-enum > .tsd-kind-icon:before {
 792 |     background-position: -170px -136px;
 793 | }
 794 | .tsd-kind-event.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before {
 795 |     background-position: -187px -136px;
 796 | }
 797 | .tsd-kind-event.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before {
 798 |     background-position: -119px -136px;
 799 | }
 800 | .tsd-kind-event.tsd-parent-kind-interface > .tsd-kind-icon:before {
 801 |     background-position: -204px -136px;
 802 | }
 803 | .tsd-kind-event.tsd-parent-kind-interface.tsd-is-inherited
 804 |     > .tsd-kind-icon:before {
 805 |     background-position: -221px -136px;
 806 | }
 807 | 
 808 | .tsd-is-static > .tsd-kind-icon:before {
 809 |     background-position: -136px -153px;
 810 | }
 811 | .tsd-is-static.tsd-is-protected > .tsd-kind-icon:before {
 812 |     background-position: -153px -153px;
 813 | }
 814 | .tsd-is-static.tsd-is-private > .tsd-kind-icon:before {
 815 |     background-position: -119px -153px;
 816 | }
 817 | .tsd-is-static.tsd-parent-kind-class > .tsd-kind-icon:before {
 818 |     background-position: -51px -153px;
 819 | }
 820 | .tsd-is-static.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before {
 821 |     background-position: -68px -153px;
 822 | }
 823 | .tsd-is-static.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before {
 824 |     background-position: -85px -153px;
 825 | }
 826 | .tsd-is-static.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited
 827 |     > .tsd-kind-icon:before {
 828 |     background-position: -102px -153px;
 829 | }
 830 | .tsd-is-static.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before {
 831 |     background-position: -119px -153px;
 832 | }
 833 | .tsd-is-static.tsd-parent-kind-enum > .tsd-kind-icon:before {
 834 |     background-position: -170px -153px;
 835 | }
 836 | .tsd-is-static.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before {
 837 |     background-position: -187px -153px;
 838 | }
 839 | .tsd-is-static.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before {
 840 |     background-position: -119px -153px;
 841 | }
 842 | .tsd-is-static.tsd-parent-kind-interface > .tsd-kind-icon:before {
 843 |     background-position: -204px -153px;
 844 | }
 845 | .tsd-is-static.tsd-parent-kind-interface.tsd-is-inherited
 846 |     > .tsd-kind-icon:before {
 847 |     background-position: -221px -153px;
 848 | }
 849 | 
 850 | .tsd-is-static.tsd-kind-function > .tsd-kind-icon:before {
 851 |     background-position: -136px -170px;
 852 | }
 853 | .tsd-is-static.tsd-kind-function.tsd-is-protected > .tsd-kind-icon:before {
 854 |     background-position: -153px -170px;
 855 | }
 856 | .tsd-is-static.tsd-kind-function.tsd-is-private > .tsd-kind-icon:before {
 857 |     background-position: -119px -170px;
 858 | }
 859 | .tsd-is-static.tsd-kind-function.tsd-parent-kind-class > .tsd-kind-icon:before {
 860 |     background-position: -51px -170px;
 861 | }
 862 | .tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-inherited
 863 |     > .tsd-kind-icon:before {
 864 |     background-position: -68px -170px;
 865 | }
 866 | .tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected
 867 |     > .tsd-kind-icon:before {
 868 |     background-position: -85px -170px;
 869 | }
 870 | .tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited
 871 |     > .tsd-kind-icon:before {
 872 |     background-position: -102px -170px;
 873 | }
 874 | .tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-private
 875 |     > .tsd-kind-icon:before {
 876 |     background-position: -119px -170px;
 877 | }
 878 | .tsd-is-static.tsd-kind-function.tsd-parent-kind-enum > .tsd-kind-icon:before {
 879 |     background-position: -170px -170px;
 880 | }
 881 | .tsd-is-static.tsd-kind-function.tsd-parent-kind-enum.tsd-is-protected
 882 |     > .tsd-kind-icon:before {
 883 |     background-position: -187px -170px;
 884 | }
 885 | .tsd-is-static.tsd-kind-function.tsd-parent-kind-enum.tsd-is-private
 886 |     > .tsd-kind-icon:before {
 887 |     background-position: -119px -170px;
 888 | }
 889 | .tsd-is-static.tsd-kind-function.tsd-parent-kind-interface
 890 |     > .tsd-kind-icon:before {
 891 |     background-position: -204px -170px;
 892 | }
 893 | .tsd-is-static.tsd-kind-function.tsd-parent-kind-interface.tsd-is-inherited
 894 |     > .tsd-kind-icon:before {
 895 |     background-position: -221px -170px;
 896 | }
 897 | 
 898 | .tsd-is-static.tsd-kind-method > .tsd-kind-icon:before {
 899 |     background-position: -136px -170px;
 900 | }
 901 | .tsd-is-static.tsd-kind-method.tsd-is-protected > .tsd-kind-icon:before {
 902 |     background-position: -153px -170px;
 903 | }
 904 | .tsd-is-static.tsd-kind-method.tsd-is-private > .tsd-kind-icon:before {
 905 |     background-position: -119px -170px;
 906 | }
 907 | .tsd-is-static.tsd-kind-method.tsd-parent-kind-class > .tsd-kind-icon:before {
 908 |     background-position: -51px -170px;
 909 | }
 910 | .tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-inherited
 911 |     > .tsd-kind-icon:before {
 912 |     background-position: -68px -170px;
 913 | }
 914 | .tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected
 915 |     > .tsd-kind-icon:before {
 916 |     background-position: -85px -170px;
 917 | }
 918 | .tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited
 919 |     > .tsd-kind-icon:before {
 920 |     background-position: -102px -170px;
 921 | }
 922 | .tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-private
 923 |     > .tsd-kind-icon:before {
 924 |     background-position: -119px -170px;
 925 | }
 926 | .tsd-is-static.tsd-kind-method.tsd-parent-kind-enum > .tsd-kind-icon:before {
 927 |     background-position: -170px -170px;
 928 | }
 929 | .tsd-is-static.tsd-kind-method.tsd-parent-kind-enum.tsd-is-protected
 930 |     > .tsd-kind-icon:before {
 931 |     background-position: -187px -170px;
 932 | }
 933 | .tsd-is-static.tsd-kind-method.tsd-parent-kind-enum.tsd-is-private
 934 |     > .tsd-kind-icon:before {
 935 |     background-position: -119px -170px;
 936 | }
 937 | .tsd-is-static.tsd-kind-method.tsd-parent-kind-interface
 938 |     > .tsd-kind-icon:before {
 939 |     background-position: -204px -170px;
 940 | }
 941 | .tsd-is-static.tsd-kind-method.tsd-parent-kind-interface.tsd-is-inherited
 942 |     > .tsd-kind-icon:before {
 943 |     background-position: -221px -170px;
 944 | }
 945 | 
 946 | .tsd-is-static.tsd-kind-call-signature > .tsd-kind-icon:before {
 947 |     background-position: -136px -170px;
 948 | }
 949 | .tsd-is-static.tsd-kind-call-signature.tsd-is-protected
 950 |     > .tsd-kind-icon:before {
 951 |     background-position: -153px -170px;
 952 | }
 953 | .tsd-is-static.tsd-kind-call-signature.tsd-is-private > .tsd-kind-icon:before {
 954 |     background-position: -119px -170px;
 955 | }
 956 | .tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class
 957 |     > .tsd-kind-icon:before {
 958 |     background-position: -51px -170px;
 959 | }
 960 | .tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-inherited
 961 |     > .tsd-kind-icon:before {
 962 |     background-position: -68px -170px;
 963 | }
 964 | .tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected
 965 |     > .tsd-kind-icon:before {
 966 |     background-position: -85px -170px;
 967 | }
 968 | .tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited
 969 |     > .tsd-kind-icon:before {
 970 |     background-position: -102px -170px;
 971 | }
 972 | .tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-private
 973 |     > .tsd-kind-icon:before {
 974 |     background-position: -119px -170px;
 975 | }
 976 | .tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum
 977 |     > .tsd-kind-icon:before {
 978 |     background-position: -170px -170px;
 979 | }
 980 | .tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-protected
 981 |     > .tsd-kind-icon:before {
 982 |     background-position: -187px -170px;
 983 | }
 984 | .tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-private
 985 |     > .tsd-kind-icon:before {
 986 |     background-position: -119px -170px;
 987 | }
 988 | .tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-interface
 989 |     > .tsd-kind-icon:before {
 990 |     background-position: -204px -170px;
 991 | }
 992 | .tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-interface.tsd-is-inherited
 993 |     > .tsd-kind-icon:before {
 994 |     background-position: -221px -170px;
 995 | }
 996 | 
 997 | .tsd-is-static.tsd-kind-event > .tsd-kind-icon:before {
 998 |     background-position: -136px -187px;
 999 | }
1000 | .tsd-is-static.tsd-kind-event.tsd-is-protected > .tsd-kind-icon:before {
1001 |     background-position: -153px -187px;
1002 | }
1003 | .tsd-is-static.tsd-kind-event.tsd-is-private > .tsd-kind-icon:before {
1004 |     background-position: -119px -187px;
1005 | }
1006 | .tsd-is-static.tsd-kind-event.tsd-parent-kind-class > .tsd-kind-icon:before {
1007 |     background-position: -51px -187px;
1008 | }
1009 | .tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-inherited
1010 |     > .tsd-kind-icon:before {
1011 |     background-position: -68px -187px;
1012 | }
1013 | .tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected
1014 |     > .tsd-kind-icon:before {
1015 |     background-position: -85px -187px;
1016 | }
1017 | .tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited
1018 |     > .tsd-kind-icon:before {
1019 |     background-position: -102px -187px;
1020 | }
1021 | .tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-private
1022 |     > .tsd-kind-icon:before {
1023 |     background-position: -119px -187px;
1024 | }
1025 | .tsd-is-static.tsd-kind-event.tsd-parent-kind-enum > .tsd-kind-icon:before {
1026 |     background-position: -170px -187px;
1027 | }
1028 | .tsd-is-static.tsd-kind-event.tsd-parent-kind-enum.tsd-is-protected
1029 |     > .tsd-kind-icon:before {
1030 |     background-position: -187px -187px;
1031 | }
1032 | .tsd-is-static.tsd-kind-event.tsd-parent-kind-enum.tsd-is-private
1033 |     > .tsd-kind-icon:before {
1034 |     background-position: -119px -187px;
1035 | }
1036 | .tsd-is-static.tsd-kind-event.tsd-parent-kind-interface
1037 |     > .tsd-kind-icon:before {
1038 |     background-position: -204px -187px;
1039 | }
1040 | .tsd-is-static.tsd-kind-event.tsd-parent-kind-interface.tsd-is-inherited
1041 |     > .tsd-kind-icon:before {
1042 |     background-position: -221px -187px;
1043 | }
1044 | 


--------------------------------------------------------------------------------