Skip to content

Commit

Permalink
Remove Table of Contents from README and UPGRADING
Browse files Browse the repository at this point in the history
Ref: vweevers/hallmark@19f4a8f
Category: none
  • Loading branch information
vweevers committed Oct 21, 2024
1 parent aab7721 commit a069162
Show file tree
Hide file tree
Showing 2 changed files with 0 additions and 193 deletions.
152 changes: 0 additions & 152 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,158 +13,6 @@
[![Common Changelog](https://common-changelog.org/badge.svg)](https://common-changelog.org)
[![Donate](https://img.shields.io/badge/donate-orange?logo=open-collective\&logoColor=fff)](https://opencollective.com/level)

## Table of Contents

<details><summary>Click to expand</summary>

- [Usage](#usage)
- [Supported Platforms](#supported-platforms)
- [Public API For Consumers](#public-api-for-consumers)
- [`db = new Constructor(...[, options])`](#db--new-constructor-options)
- [`db.status`](#dbstatus)
- [`db.open([options])`](#dbopenoptions)
- [`db.close()`](#dbclose)
- [`db.supports`](#dbsupports)
- [`db.get(key[, options])`](#dbgetkey-options)
- [`db.getMany(keys[, options])`](#dbgetmanykeys-options)
- [`db.put(key, value[, options])`](#dbputkey-value-options)
- [`db.del(key[, options])`](#dbdelkey-options)
- [`db.batch(operations[, options])`](#dbbatchoperations-options)
- [`chainedBatch = db.batch()`](#chainedbatch--dbbatch)
- [`iterator = db.iterator([options])`](#iterator--dbiteratoroptions)
- [`keyIterator = db.keys([options])`](#keyiterator--dbkeysoptions)
- [`valueIterator = db.values([options])`](#valueiterator--dbvaluesoptions)
- [`db.clear([options])`](#dbclearoptions)
- [`sublevel = db.sublevel(name[, options])`](#sublevel--dbsublevelname-options)
- [`encoding = db.keyEncoding([encoding])`](#encoding--dbkeyencodingencoding)
- [`encoding = db.valueEncoding([encoding])`](#encoding--dbvalueencodingencoding)
- [`key = db.prefixKey(key, keyFormat[, local])`](#key--dbprefixkeykey-keyformat-local)
- [`db.defer(fn[, options])`](#dbdeferfn-options)
- [`db.deferAsync(fn[, options])`](#dbdeferasyncfn-options)
- [`chainedBatch`](#chainedbatch)
- [`chainedBatch.put(key, value[, options])`](#chainedbatchputkey-value-options)
- [`chainedBatch.del(key[, options])`](#chainedbatchdelkey-options)
- [`chainedBatch.clear()`](#chainedbatchclear)
- [`chainedBatch.write([options])`](#chainedbatchwriteoptions)
- [`chainedBatch.close()`](#chainedbatchclose)
- [`chainedBatch.length`](#chainedbatchlength)
- [`chainedBatch.db`](#chainedbatchdb)
- [`iterator`](#iterator)
- [`for await...of iterator`](#for-awaitof-iterator)
- [`iterator.next()`](#iteratornext)
- [`iterator.nextv(size[, options])`](#iteratornextvsize-options)
- [`iterator.all([options])`](#iteratoralloptions)
- [`iterator.seek(target[, options])`](#iteratorseektarget-options)
- [`iterator.close()`](#iteratorclose)
- [`iterator.db`](#iteratordb)
- [`iterator.count`](#iteratorcount)
- [`iterator.limit`](#iteratorlimit)
- [Aborting Iterators](#aborting-iterators)
- [`keyIterator`](#keyiterator)
- [`valueIterator`](#valueiterator)
- [`sublevel`](#sublevel)
- [`sublevel.prefix`](#sublevelprefix)
- [`sublevel.parent`](#sublevelparent)
- [`sublevel.db`](#subleveldb)
- [`sublevel.path([local])`](#sublevelpathlocal)
- [Hooks](#hooks)
- [`hook = db.hooks.prewrite`](#hook--dbhooksprewrite)
- [Example](#example)
- [Arguments](#arguments)
- [`op` (object)](#op-object)
- [`batch` (object)](#batch-object)
- [`batch = batch.add(op)`](#batch--batchaddop)
- [`hook = db.hooks.postopen`](#hook--dbhookspostopen)
- [Example](#example-1)
- [Arguments](#arguments-1)
- [`options` (object)](#options-object)
- [`hook = db.hooks.newsub`](#hook--dbhooksnewsub)
- [Example](#example-2)
- [Arguments](#arguments-2)
- [`sublevel` (object)](#sublevel-object)
- [`options` (object)](#options-object-1)
- [`hook`](#hook)
- [`hook.add(fn)`](#hookaddfn)
- [`hook.delete(fn)`](#hookdeletefn)
- [Hook Error Handling](#hook-error-handling)
- [Hooks On Sublevels](#hooks-on-sublevels)
- [Encodings](#encodings)
- [Events](#events)
- [`opening`](#opening)
- [`open`](#open)
- [`closing`](#closing)
- [`closed`](#closed)
- [`write`](#write)
- [`clear`](#clear)
- [`put` (deprecated)](#put-deprecated)
- [`del` (deprecated)](#del-deprecated)
- [`batch` (deprecated)](#batch-deprecated)
- [Errors](#errors)
- [`LEVEL_DATABASE_NOT_OPEN`](#level_database_not_open)
- [`LEVEL_DATABASE_NOT_CLOSED`](#level_database_not_closed)
- [`LEVEL_ITERATOR_NOT_OPEN`](#level_iterator_not_open)
- [`LEVEL_ITERATOR_BUSY`](#level_iterator_busy)
- [`LEVEL_BATCH_NOT_OPEN`](#level_batch_not_open)
- [`LEVEL_ABORTED`](#level_aborted)
- [`LEVEL_ENCODING_NOT_FOUND`](#level_encoding_not_found)
- [`LEVEL_ENCODING_NOT_SUPPORTED`](#level_encoding_not_supported)
- [`LEVEL_DECODE_ERROR`](#level_decode_error)
- [`LEVEL_INVALID_KEY`](#level_invalid_key)
- [`LEVEL_INVALID_VALUE`](#level_invalid_value)
- [`LEVEL_CORRUPTION`](#level_corruption)
- [`LEVEL_IO_ERROR`](#level_io_error)
- [`LEVEL_INVALID_PREFIX`](#level_invalid_prefix)
- [`LEVEL_NOT_SUPPORTED`](#level_not_supported)
- [`LEVEL_LEGACY`](#level_legacy)
- [`LEVEL_LOCKED`](#level_locked)
- [`LEVEL_HOOK_ERROR`](#level_hook_error)
- [`LEVEL_STATUS_LOCKED`](#level_status_locked)
- [`LEVEL_READONLY`](#level_readonly)
- [`LEVEL_CONNECTION_LOST`](#level_connection_lost)
- [`LEVEL_REMOTE_ERROR`](#level_remote_error)
- [Shared Access](#shared-access)
- [Private API For Implementors](#private-api-for-implementors)
- [Example](#example-3)
- [`db = AbstractLevel(manifest[, options])`](#db--abstractlevelmanifest-options)
- [`db._open(options)`](#db_openoptions)
- [`db._close()`](#db_close)
- [`db._get(key, options)`](#db_getkey-options)
- [`db._getMany(keys, options)`](#db_getmanykeys-options)
- [`db._put(key, value, options)`](#db_putkey-value-options)
- [`db._del(key, options)`](#db_delkey-options)
- [`db._batch(operations, options)`](#db_batchoperations-options)
- [`db._chainedBatch()`](#db_chainedbatch)
- [`db._iterator(options)`](#db_iteratoroptions)
- [`db._keys(options)`](#db_keysoptions)
- [`db._values(options)`](#db_valuesoptions)
- [`db._clear(options)`](#db_clearoptions)
- [`sublevel = db._sublevel(name, options)`](#sublevel--db_sublevelname-options)
- [`iterator = AbstractIterator(db, options)`](#iterator--abstractiteratordb-options)
- [`iterator._next()`](#iterator_next)
- [`iterator._nextv(size, options)`](#iterator_nextvsize-options)
- [`iterator._all(options)`](#iterator_alloptions)
- [`iterator._seek(target, options)`](#iterator_seektarget-options)
- [`iterator._close()`](#iterator_close)
- [`keyIterator = AbstractKeyIterator(db, options)`](#keyiterator--abstractkeyiteratordb-options)
- [`valueIterator = AbstractValueIterator(db, options)`](#valueiterator--abstractvalueiteratordb-options)
- [`chainedBatch = AbstractChainedBatch(db, options)`](#chainedbatch--abstractchainedbatchdb-options)
- [`chainedBatch._add(op)`](#chainedbatch_addop)
- [`chainedBatch._put(key, value, options)`](#chainedbatch_putkey-value-options)
- [`chainedBatch._del(key, options)`](#chainedbatch_delkey-options)
- [`chainedBatch._clear()`](#chainedbatch_clear)
- [`chainedBatch._write(options)`](#chainedbatch_writeoptions)
- [`chainedBatch._close()`](#chainedbatch_close)
- [Test Suite](#test-suite)
- [Excluding tests](#excluding-tests)
- [Reusing `testCommon`](#reusing-testcommon)
- [Spread The Word](#spread-the-word)
- [Install](#install)
- [Contributing](#contributing)
- [Donate](#donate)
- [License](#license)

</details>

## Usage

This module exports an abstract class that should not be instantiated by end users. Instead use modules like [`level`](https://github.com/Level/level) that contain a concrete implementation and actual data storage. The purpose of the abstract class is to provide a common interface that looks like this:
Expand Down
41 changes: 0 additions & 41 deletions UPGRADING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,47 +2,6 @@

This document describes breaking changes and how to upgrade. For a complete list of changes including minor and patch releases, please refer to the [changelog](CHANGELOG.md).

## Table of Contents

<details><summary>Click to expand</summary>

- [2.0.0](#200)
- [1. Public API](#1-public-api)
- [1.1. Callbacks have been removed](#11-callbacks-have-been-removed)
- [1.2. Not found](#12-not-found)
- [1.3. Not ready](#13-not-ready)
- [1.4. Slower nested sublevels](#14-slower-nested-sublevels)
- [1.5. Open before creating a chained batch](#15-open-before-creating-a-chained-batch)
- [2. Private API](#2-private-api)
- [2.1. Promises all the way](#21-promises-all-the-way)
- [2.2. Ticks](#22-ticks)
- [2.3. A new way to abort iterator work](#23-a-new-way-to-abort-iterator-work)
- [2.4. Snapshots must be synchronous](#24-snapshots-must-be-synchronous)
- [1.0.0](#100)
- [1. API parity with `levelup`](#1-api-parity-with-levelup)
- [1.1. New: promises](#11-new-promises)
- [1.2. New: events](#12-new-events)
- [1.3. New: idempotent open](#13-new-idempotent-open)
- [1.4. New: deferred open](#14-new-deferred-open)
- [1.5. No constructor callback](#15-no-constructor-callback)
- [1.6. New: state checks](#16-new-state-checks)
- [1.7. New: chained batch length](#17-new-chained-batch-length)
- [2. API parity with `level`](#2-api-parity-with-level)
- [2.1. For consumers](#21-for-consumers)
- [2.2. For implementors](#22-for-implementors)
- [2.3. Other notable changes](#23-other-notable-changes)
- [3. Streams have moved](#3-streams-have-moved)
- [4. Zero-length keys and range options are now valid](#4-zero-length-keys-and-range-options-are-now-valid)
- [5. Resources are auto-closed](#5-resources-are-auto-closed)
- [5.1. Closing iterators is idempotent](#51-closing-iterators-is-idempotent)
- [5.2. Chained batch can be closed](#52-chained-batch-can-be-closed)
- [6. Errors now use codes](#6-errors-now-use-codes)
- [7. Semi-private properties have been removed](#7-semi-private-properties-have-been-removed)
- [8. Changes to test suite](#8-changes-to-test-suite)
- [9. Sublevels are builtin](#9-sublevels-are-builtin)

</details>

## 2.0.0

**This release adds [hooks](./README.md#hooks) and drops callbacks, not-found errors and support of Node.js < 16. The guide for this release consists of two sections. One for the public API, relevant to all consumers of `abstract-level` and implementations thereof (`level`, `classic-level`, `memory-level` et cetera) and another for the private API that only implementors should have to read.**
Expand Down

0 comments on commit a069162

Please sign in to comment.