memdown - GitLite

KO | EN

gitlite — search

#react #typescript #golang #android #deep-learning #linux #docker #macos #java #awesome #kubernetes #awesome-list #pytorch #openai

memdown

(★ 286)

Superseded by memory-level. In-memory abstract-leveldown store for Node.js and browsers.

파일 탐색기

최종 버전 다운로드 (.zip)

- - release.yml
  - sauce.yml
  - test.yml
- dependabot.yml
.airtap.yml
.gitignore
CHANGELOG.md
LICENSE
memdown.js
package.json
README.md
sauce-labs.svg
test.js
UPGRADING.md

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/Level/memdown

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd memdown

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Node.js

쉬움 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Node.js npm 명령어를 쓰려면 Node.js가 설치되어 있어야 합니다. LTS(장기지원) 버전을 추천합니다.

npm run test-browser-local

이 명령어를 터미널에 그대로 입력해 실행하세요.

npm run coverage

이 명령어를 터미널에 그대로 입력해 실행하세요.

✅ 명령어 실행 후 터미널에 나타나는 주소(보통 http://localhost:3000 형태)를 브라우저에서 열어보세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# memdown

**Superseded by [`memory-level`](https://github.com/Level/memory-level). Please see [Frequently Asked Questions](https://github.com/Level/community#faq).**

## Example

_If you are upgrading: please see [`UPGRADING.md`](./UPGRADING.md)._

```js
const levelup = require('levelup')
const memdown = require('memdown')

const db = levelup(memdown())

db.put('hey', 'you', (err) => {
  if (err) throw err

db.get('hey', { asBuffer: false }, (err, value) => {
    if (err) throw err
    console.log(value) // 'you'
  })
})
```

With `async/await`:

```js
await db.put('hey', 'you')
const value = await db.get('hey', { asBuffer: false })
```

Your data is discarded when the process ends or you release a reference to the store. Note as well, though the internals of `memdown` operate synchronously - [`levelup`] does not.

## Browser support

[![Sauce Test Status](https://app.saucelabs.com/browser-matrix/level-ci.svg)](https://app.saucelabs.com/u/level-ci)

## Data types

Keys and values can be strings or Buffers. Any other key type will be irreversibly stringified. The only exceptions are `null` and `undefined`. Keys and values of that type are rejected.

```js
const db = levelup(memdown())

db.put('example', 123, (err) => {
  if (err) throw err

db.createReadStream({
    keyAsBuffer: false,
    valueAsBuffer: false
  }).on('data', (entry) => {
    console.log(typeof entry.key) // 'string'
    console.log(typeof entry.value) // 'string'
  })
})
```

If you desire non-destructive encoding (e.g. to store and retrieve numbers as-is), wrap `memdown` with [`encoding-down`]. Alternatively install [`level-mem`] which conveniently bundles [`levelup`], `memdown` and [`encoding-down`]. Such an approach is also recommended if you want to achieve universal (isomorphic) behavior. For example, you could have [`leveldown`] in a backend and `memdown` in the frontend.

```js
const encode = require('encoding-down')
const db = levelup(encode(memdown(), { valueEncoding: 'json' }))

db.put('example', 123, (err) => {
  if (err) throw err

db.createReadStream({
    keyAsBuffer: false,
    valueAsBuffer: false
  }).on('data', (entry) => {
    console.log(typeof entry.key) // 'string'
    console.log(typeof entry.value) // 'number'
  })
})
```

## Snapshot guarantees

A `memdown` store is backed by [a fully persistent data structure](https://www.npmjs.com/package/functional-red-black-tree) and thus has snapshot guarantees. Meaning that reads operate on a snapshot in time, unaffected by simultaneous writes.

## Test

In addition to the regular `npm test`, you can test `memdown` in a browser of choice with:

```
npm run test-browser-local
```

To check code coverage:

```
npm run coverage
```

## Contributing

[`Level/memdown`](https://github.com/Level/memdown) is an **OPEN Open Source Project**. This means that:

> Individuals making significant and valuable contributions are given commit-access to the project to contribute as they see fit. This project is more like an open wiki than a standard guarded open source project.

See the [Contribution Guide](https://github.com/Level/community/blob/master/CONTRIBUTING.md) for more details.

## Big Thanks

Cross-browser Testing Platform and Open Source ♥ Provided by [Sauce Labs](https://saucelabs.com).

[![Sauce Labs logo](https://raw.githubusercontent.com/Level/memdown/master/sauce-labs.svg)](https://saucelabs.com)

## Donate

Support us with a monthly donation on [Open Collective](https://opencollective.com/level) and help us continue our work.

## License

[MIT](LICENSE)

[`abstract-leveldown`]: https://github.com/Level/abstract-leveldown

[`levelup`]: https://github.com/Level/levelup

[`encoding-down`]: https://github.com/Level/encoding-down

[`leveldown`]: https://github.com/Level/leveldown

[`level-mem`]: https://github.com/Level/mem

[level-badge]: https://leveljs.org/img/badge.svg