Skip to content

Commit

Permalink
fix: Correct type declaration errors and enhance parameter descriptio…
Browse files Browse the repository at this point in the history
…ns for insert, delete, exists methods
  • Loading branch information
izure1 committed Sep 24, 2024
1 parent cb4a4ca commit a5683a1
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 8 deletions.
9 changes: 5 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
{
"name": "serializable-bptree",
"version": "4.0.2",
"version": "4.0.3",
"description": "Store the B+tree flexibly, not only in-memory.",
"main": "dist/cjs/index.cjs",
"module": "dist/esm/index.mjs",
"typings": "dist/typings/index.d.ts",
"types": "./dist/types/index.d.ts",
"main": "./dist/cjs/index.cjs",
"module": "./dist/esm/index.mjs",
"exports": {
".": {
"types": "./dist/types/index.d.ts",
"import": "./dist/esm/index.mjs",
"require": "./dist/cjs/index.cjs"
}
Expand Down
6 changes: 3 additions & 3 deletions src/base/BPTree.ts
Original file line number Diff line number Diff line change
Expand Up @@ -189,19 +189,19 @@ export abstract class BPTree<K, V> {
/**
* You enter the key and value as a pair. You can later search for the pair by value.
* This data is stored in the tree, sorted in ascending order of value.
* @param key The key of the pair.
* @param key The key of the pair. This key must be unique.
* @param value The value of the pair.
*/
public abstract insert(key: K, value: V): Deferred<void>
/**
* Deletes the pair that matches the key and value.
* @param key The key of the pair.
* @param key The key of the pair. This key must be unique.
* @param value The value of the pair.
*/
public abstract delete(key: K, value: V): Deferred<void>
/**
* It returns whether there is a value in the tree.
* @param key The key value to search for.
* @param key The key value to search for. This key must be unique.
* @param value The value to search for.
*/
public abstract exists(key: K, value: V): Deferred<boolean>
Expand Down
2 changes: 1 addition & 1 deletion tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@
"emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */
// "sourceMap": true, /* Create source map files for emitted JavaScript files. */
// "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
"outDir": "./dist/typings", /* Specify an output folder for all emitted files. */
"outDir": "./dist/types", /* Specify an output folder for all emitted files. */
// "removeComments": true, /* Disable emitting comments. */
// "noEmit": true, /* Disable emitting files from a compilation. */
// "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
Expand Down

0 comments on commit a5683a1

Please sign in to comment.