This repository was archived by the owner on Feb 12, 2024. It is now read-only.
feat: add typeScript support #3236
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,13 +3,64 @@ | |
| const importer = require('ipfs-unixfs-importer') | ||
| const normaliseAddInput = require('ipfs-core-utils/src/files/normalise-input') | ||
| const { parseChunkerString } = require('./utils') | ||
| const { pipe } = require('it-pipe') | ||
| const { withTimeoutOption } = require('../../utils') | ||
|
|
||
| /** | ||
| * @typedef {Uint8Array | Blob | String | Iterable<Uint8Array> | Iterable<number> | AsyncIterable<Uint8Array> | ReadableStream<Uint8Array>} FileContent | ||
| * | ||
| * @typedef {object} FileObject | ||
| * - If no path is specified, then the item will be added to the root level and will be given a name according to it's CID. | ||
| * - If no content is passed, then the item is treated as an empty directory. | ||
| * - One of path or content must be passed. | ||
| * @property {string} [path] - The path you want to the file to be accessible at from the root CID _after_ it has been added | ||
| * @property {FileContent} [content] - The contents of the file | ||
| * @property {number | string} [mode] - File mode to store the entry with (see https://en.wikipedia.org/wiki/File_system_permissions#Numeric_notation) | ||
| * @property {UnixTime} [mtime] - The modification time of the entry | ||
|
There was a problem hiding this comment. 📝 If you want to be more precise (not asking you to, I have taken same shortcuts myself) type FileObject =
| { path: string, mode?: Mode, mtime?: UnixTime } // Directory
| { path?: string, content: FileContent, mtime?: UnixTime } // FileThat is to say it must have path or a content or both. |
||
| * | ||
| * @typedef {FileContent | FileObject} Source | ||
|
There was a problem hiding this comment. 💭 I think it would be better to call this something like |
||
| * @typedef {Iterable<Source> | AsyncIterable<Source> | ReadableStream<Source>} FileStream | ||
|
There was a problem hiding this comment. @achingbrain now that I'm looking at it, I find There was a problem hiding this comment. Sure, I'm all for making it more straightforward. Input streams are largely called |
||
| * | ||
| * @typedef {Date | UnixTimeObj | [number, number]} UnixTime - As an array of numbers, it must have two elements, as per the output of [`process.hrtime()`](https://nodejs.org/dist/latest/docs/api/process.html#process_process_hrtime_time). | ||
| * | ||
| * @typedef {object} UnixTimeObj | ||
| * @property {number} secs - the number of seconds since (positive) or before (negative) the Unix Epoch began | ||
| * @property {number} [nsecs] - the number of nanoseconds since the last full second. | ||
| * | ||
| * @typedef {object} UnixFSEntry | ||
| * @property {string} path | ||
| * @property {import('cids')} cid | ||
| * @property {number} mode | ||
| * @property {UnixTimeObj} mtime | ||
| * @property {number} size | ||
| */ | ||
|
|
||
| module.exports = ({ block, gcLock, preload, pin, options: constructorOptions }) => { | ||
| const isShardingEnabled = constructorOptions.EXPERIMENTAL && constructorOptions.EXPERIMENTAL.sharding | ||
|
|
||
| /** | ||
| * Import multiple files and data into IPFS. | ||
| * | ||
| * @param {FileStream} source | ||
| * | ||
| * @param {object} [options] | ||
| * @param {string} [options.chunker] - chunking algorithm used to build ipfs DAGs (default: `'size-262144'`) | ||
| * @param {Number} [options.cidVersion] - the CID version to use when storing the data (default: `0`) | ||
| * @param {boolean} [options.enableShardingExperiment] - allows to create directories with an unlimited number of entries currently size of unixfs directories is limited by the maximum block size. Note that this is an experimental feature (default: `false`) | ||
| * @param {String} [options.hashAlg] - multihash hashing algorithm to use (default: `'sha2-256'`) | ||
| * @param {boolean} [options.onlyHash] - If true, will not add blocks to the blockstore (default: `false`) | ||
| * @param {boolean} [options.pin] - pin this object when adding (default: `true`) | ||
| * @param {function} [options.progress] - a function that will be called with the byte length of chunks as a file is added to ipfs (default: `undefined`) | ||
| * @param {boolean} [options.rawLeaves] - if true, DAG leaves will contain raw file data and not be wrapped in a protobuf (default: `false`) | ||
| * @param {Number} [options.shardSplitThreshold] - Directories with more than this number of files will be created as HAMT-sharded directories (default: `1000`) | ||
| * @param {boolean} [options.trickle] - if true will use the [trickle DAG](https://godoc.org/github.com/ipsn/go-ipfs/gxlibs/github.com/ipfs/go-unixfs/importer/trickle) format for DAG generation (default: `false`) | ||
| * @param {boolean} [options.wrapWithDirectory] - Adds a wrapping node around the content (default: `false`) | ||
| * @param {Number} [options.timeout] - A timeout in ms (default: `undefined`) | ||
| * @param {AbortSignal} [options.signal] - Can be used to cancel any long running requests started as a result of this call (default: `undefined`) | ||
|
|
||
| * @returns {AsyncIterable<UnixFSEntry>} | ||
| */ | ||
| async function * addAll (source, options) { | ||
| options = options || {} | ||
|
|
||
| const opts = { | ||
|
|
@@ -58,7 +109,9 @@ module.exports = ({ block, gcLock, preload, pin, options: constructorOptions }) | |
| } finally { | ||
| releaseLock() | ||
| } | ||
| } | ||
|
|
||
| return withTimeoutOption(addAll) | ||
| } | ||
|
|
||
| function transformFile (opts) { | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,11 +1,33 @@ | ||
| 'use strict' | ||
|
|
||
| const Big = require('bignumber.js').default | ||
|
There was a problem hiding this comment. Is this change necessary ? From their website this is how they suggest to import So I would much rather keep it as it was, unless absolutely necessary. Otherwise it's fine. There was a problem hiding this comment. To make the typings work, the export signature in its export default BigNumber;
export declare class BigNumber ...is either There was a problem hiding this comment. I think when namespace and class name do collide in definitions TS does know to not require default, but I could be wrong and it might be behind some config flag. I think I'd still prefer |
||
| const CID = require('cids') | ||
| const { withTimeoutOption } = require('../../utils') | ||
|
|
||
| /** | ||
| * @typedef {object} BitswapStats - An object that contains information about the bitswap agent | ||
| * @property {number} provideBufLen - an integer | ||
| * @property {import('cids')[]} wantlist | ||
| * @property {string[]} peers - array of peer IDs as Strings | ||
| * @property {Big} blocksReceived | ||
| * @property {Big} dataReceived | ||
| * @property {Big} blocksSent | ||
| * @property {Big} dataSent | ||
| * @property {Big} dupBlksReceived | ||
| * @property {Big} dupDataReceived | ||
| */ | ||
|
|
||
| module.exports = ({ bitswap }) => { | ||
| /** | ||
| * Show diagnostic information on the bitswap agent. | ||
| * | ||
| * @param {object} [options] | ||
| * @param {Number} [options.timeout] - A timeout in ms (default: `undefined`) | ||
| * @param {AbortSignal} [options.signal] - Can be used to cancel any long running requests started as a result of this call (default: `undefined`) | ||
| * | ||
| * @returns {Promise<BitswapStats>} | ||
| */ | ||
| async function stat (options) { // eslint-disable-line require-await, @typescript-eslint/no-unused-vars | ||
| const snapshot = bitswap.stat().snapshot | ||
|
|
||
| return { | ||
|
|
@@ -19,5 +41,7 @@ module.exports = ({ bitswap }) => { | |
| blocksSent: new Big(snapshot.blocksSent), | ||
| dataSent: new Big(snapshot.dataSent) | ||
| } | ||
| } | ||
|
|
||
| return withTimeoutOption(stat) | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Any reason why to note add
@returntype here and do it on line 18 instead ?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
eslint valid-jsdoc requires an
@returnon line 18, and the default return type for@callbackdefinition isany