Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: update api docs #244

Merged
merged 1 commit into from
Sep 5, 2023
Merged

docs: update api docs #244

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 2 additions & 6 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,6 @@
"bugs": {
"url": "https://github.com/ipfs/js-stores/issues"
},
"engines": {
"node": ">=16.0.0",
"npm": ">=7.0.0"
},
"private": true,
"scripts": {
"reset": "aegir run clean && aegir clean ./node_modules ./package-lock.json packages/*/node_modules packages/*/package-lock.json packages/*/dist",
Expand All @@ -29,8 +25,8 @@
"clean": "aegir run clean",
"build": "aegir run build",
"lint": "aegir run lint",
"docs": "NODE_OPTIONS=--max_old_space_size=4096 aegir docs",
"docs:no-publish": "npm run docs -- --publish false",
"docs": "NODE_OPTIONS=--max_old_space_size=8192 aegir docs",
"docs:no-publish": "NODE_OPTIONS=--max_old_space_size=8192 aegir docs --publish false",
"dep-check": "aegir run dep-check",
"release": "npm run docs:no-publish && aegir run release && npm run docs"
},
Expand Down
7 changes: 0 additions & 7 deletions packages/blockstore-core/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,6 @@
"ipfs",
"key-value"
],
"engines": {
"node": ">=16.0.0",
"npm": ">=7.0.0"
},
"type": "module",
"types": "./dist/src/index.d.ts",
"typesVersions": {
Expand Down Expand Up @@ -193,8 +189,5 @@
"devDependencies": {
"aegir": "^40.0.8",
"interface-blockstore-tests": "^6.0.0"
},
"typedoc": {
"entryPoint": "./src/index.ts"
}
}
10 changes: 10 additions & 0 deletions packages/blockstore-core/typedoc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"entryPoints": [
"./src/index.ts",
"./src/base.ts",
"./src/black-hole.ts",
"./src/errors.ts",
"./src/memory.ts",
"./src/tiered.ts"
]
}
7 changes: 0 additions & 7 deletions packages/blockstore-fs/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,6 @@
"ipfs",
"key-value"
],
"engines": {
"node": ">=16.0.0",
"npm": ">=7.0.0"
},
"type": "module",
"types": "./dist/src/index.d.ts",
"typesVersions": {
Expand Down Expand Up @@ -175,8 +171,5 @@
"devDependencies": {
"aegir": "^40.0.8",
"interface-blockstore-tests": "^6.0.0"
},
"typedoc": {
"entryPoint": "./src/index.ts"
}
}
6 changes: 6 additions & 0 deletions packages/blockstore-fs/typedoc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"entryPoints": [
"./src/index.ts",
"./src/sharding.ts"
]
}
7 changes: 0 additions & 7 deletions packages/blockstore-idb/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,6 @@
"ipfs",
"key-value"
],
"engines": {
"node": ">=16.0.0",
"npm": ">=7.0.0"
},
"type": "module",
"types": "./dist/src/index.d.ts",
"files": [
Expand Down Expand Up @@ -151,8 +147,5 @@
"devDependencies": {
"aegir": "^40.0.8",
"interface-blockstore-tests": "^6.0.0"
},
"typedoc": {
"entryPoint": "./src/index.ts"
}
}
5 changes: 5 additions & 0 deletions packages/blockstore-idb/typedoc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"entryPoints": [
"./src/index.ts"
]
}
7 changes: 0 additions & 7 deletions packages/blockstore-level/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,6 @@
"leveldown",
"levelup"
],
"engines": {
"node": ">=16.0.0",
"npm": ">=7.0.0"
},
"type": "module",
"types": "./dist/src/index.d.ts",
"files": [
Expand Down Expand Up @@ -156,8 +152,5 @@
"interface-blockstore-tests": "^6.0.0",
"ipfs-utils": "^9.0.4",
"memory-level": "^1.0.0"
},
"typedoc": {
"entryPoint": "./src/index.ts"
}
}
5 changes: 5 additions & 0 deletions packages/blockstore-level/typedoc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"entryPoints": [
"./src/index.ts"
]
}
7 changes: 0 additions & 7 deletions packages/blockstore-s3/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,6 @@
"key-value",
"s3"
],
"engines": {
"node": ">=16.0.0",
"npm": ">=7.0.0"
},
"type": "module",
"types": "./dist/src/index.d.ts",
"files": [
Expand Down Expand Up @@ -156,8 +152,5 @@
"interface-blockstore-tests": "^6.0.0",
"p-defer": "^4.0.0",
"sinon": "^15.0.2"
},
"typedoc": {
"entryPoint": "./src/index.ts"
}
}
5 changes: 5 additions & 0 deletions packages/blockstore-s3/typedoc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"entryPoints": [
"./src/index.ts"
]
}
9 changes: 1 addition & 8 deletions packages/datastore-core/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,6 @@
"ipfs",
"key-value"
],
"engines": {
"node": ">=16.0.0",
"npm": ">=7.0.0"
},
"type": "module",
"types": "./dist/src/index.d.ts",
"typesVersions": {
Expand Down Expand Up @@ -205,7 +201,7 @@
"it-drain": "^3.0.1",
"it-filter": "^3.0.0",
"it-map": "^3.0.1",
"it-merge": "^3.0.0",
"it-merge": "^3.0.1",
"it-pipe": "^3.0.0",
"it-pushable": "^3.0.0",
"it-sort": "^3.0.1",
Expand All @@ -216,8 +212,5 @@
"aegir": "^40.0.8",
"interface-datastore": "^8.0.0",
"interface-datastore-tests": "^5.0.0"
},
"typedoc": {
"entryPoint": "./src/index.ts"
}
}
15 changes: 15 additions & 0 deletions packages/datastore-core/typedoc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{
"entryPoints": [
"./src/index.ts",
"./src/base.ts",
"./src/black-hole.ts",
"./src/errors.ts",
"./src/keytransform.ts",
"./src/memory.ts",
"./src/mount.ts",
"./src/namespace.ts",
"./src/shard.ts",
"./src/sharding.ts",
"./src/tiered.ts"
]
}
7 changes: 0 additions & 7 deletions packages/datastore-fs/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,6 @@
"ipfs",
"key-value"
],
"engines": {
"node": ">=16.0.0",
"npm": ">=7.0.0"
},
"type": "module",
"types": "./dist/src/index.d.ts",
"files": [
Expand Down Expand Up @@ -153,8 +149,5 @@
"aegir": "^40.0.8",
"interface-datastore-tests": "^5.0.0",
"ipfs-utils": "^9.0.4"
},
"typedoc": {
"entryPoint": "./src/index.ts"
}
}
5 changes: 5 additions & 0 deletions packages/datastore-fs/typedoc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"entryPoints": [
"./src/index.ts"
]
}
7 changes: 0 additions & 7 deletions packages/datastore-idb/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,6 @@
"ipfs",
"key-value"
],
"engines": {
"node": ">=16.0.0",
"npm": ">=7.0.0"
},
"type": "module",
"types": "./dist/src/index.d.ts",
"files": [
Expand Down Expand Up @@ -153,8 +149,5 @@
"aegir": "^40.0.8",
"datastore-core": "^9.0.0",
"interface-datastore-tests": "^5.0.0"
},
"typedoc": {
"entryPoint": "./src/index.ts"
}
}
5 changes: 5 additions & 0 deletions packages/datastore-idb/typedoc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"entryPoints": [
"./src/index.ts"
]
}
7 changes: 0 additions & 7 deletions packages/datastore-level/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,6 @@
"leveldown",
"levelup"
],
"engines": {
"node": ">=16.0.0",
"npm": ">=7.0.0"
},
"type": "module",
"types": "./dist/src/index.d.ts",
"files": [
Expand Down Expand Up @@ -158,8 +154,5 @@
"interface-datastore-tests": "^5.0.0",
"ipfs-utils": "^9.0.4",
"memory-level": "^1.0.0"
},
"typedoc": {
"entryPoint": "./src/index.ts"
}
}
5 changes: 5 additions & 0 deletions packages/datastore-level/typedoc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"entryPoints": [
"./src/index.ts"
]
}
7 changes: 0 additions & 7 deletions packages/datastore-s3/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,6 @@
"key-value",
"s3"
],
"engines": {
"node": ">=16.0.0",
"npm": ">=7.0.0"
},
"type": "module",
"types": "./dist/src/index.d.ts",
"files": [
Expand Down Expand Up @@ -156,8 +152,5 @@
"interface-datastore-tests": "^5.0.0",
"p-defer": "^4.0.0",
"sinon": "^15.0.2"
},
"typedoc": {
"entryPoint": "./src/index.ts"
}
}
5 changes: 5 additions & 0 deletions packages/datastore-s3/typedoc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"entryPoints": [
"./src/index.ts"
]
}
7 changes: 0 additions & 7 deletions packages/interface-blockstore-tests/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,6 @@
"ipfs",
"key-value"
],
"engines": {
"node": ">=16.0.0",
"npm": ">=7.0.0"
},
"type": "module",
"types": "./dist/src/index.d.ts",
"files": [
Expand Down Expand Up @@ -142,8 +138,5 @@
},
"devDependencies": {
"aegir": "^40.0.8"
},
"typedoc": {
"entryPoint": "./src/index.js"
}
}
5 changes: 5 additions & 0 deletions packages/interface-blockstore-tests/typedoc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"entryPoints": [
"./src/index.ts"
]
}
7 changes: 0 additions & 7 deletions packages/interface-blockstore/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,6 @@
"bugs": {
"url": "https://github.com/ipfs/js-stores/issues"
},
"engines": {
"node": ">=16.0.0",
"npm": ">=7.0.0"
},
"type": "module",
"types": "./dist/src/index.d.ts",
"files": [
Expand Down Expand Up @@ -132,8 +128,5 @@
},
"devDependencies": {
"aegir": "^40.0.8"
},
"typedoc": {
"entryPoint": "./src/index.ts"
}
}
5 changes: 5 additions & 0 deletions packages/interface-blockstore/typedoc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"entryPoints": [
"./src/index.ts"
]
}
7 changes: 0 additions & 7 deletions packages/interface-datastore-tests/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,6 @@
"ipfs",
"key-value"
],
"engines": {
"node": ">=16.0.0",
"npm": ">=7.0.0"
},
"type": "module",
"types": "./dist/src/index.d.ts",
"files": [
Expand Down Expand Up @@ -143,8 +139,5 @@
},
"devDependencies": {
"aegir": "^40.0.8"
},
"typedoc": {
"entryPoint": "./src/index.ts"
}
}
5 changes: 5 additions & 0 deletions packages/interface-datastore-tests/typedoc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"entryPoints": [
"./src/index.ts"
]
}
Loading