fix: multi-repo local dev (file:../ deps, package exports, missing deps)
This commit is contained in:
+201
@@ -0,0 +1,201 @@
|
||||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
|
||||
To apply the Apache License to your work, attach the following
|
||||
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||
replaced with your own identifying information. (Don't include
|
||||
the brackets!) The text should be enclosed in the appropriate
|
||||
comment syntax for the file format. We also recommend that a
|
||||
file or class name and description of purpose be included on the
|
||||
same "printed page" as the copyright notice for easier
|
||||
identification within third-party archives.
|
||||
|
||||
Copyright [yyyy] [name of copyright owner]
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
+105
@@ -0,0 +1,105 @@
|
||||
# Rache
|
||||
|
||||
A random-eviction cache which imposes a global cache-size limit on all the caches derived from it.
|
||||
|
||||
Useful when you have many caches and want to limit their memory usage as a whole, instead of per cache.
|
||||
|
||||
The `get` and `set` operations as well as `delete` (and cache eviction) take constant time.
|
||||
|
||||
## Install
|
||||
|
||||
```
|
||||
npm i rache
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
```
|
||||
const Rache = require('rache')
|
||||
|
||||
const cache = new Rache({ maxSize: 3 })
|
||||
const cache2 = cache.sub()
|
||||
const cache3 = cache.sub()
|
||||
|
||||
cache.set('key', 'value')
|
||||
cache2.set('key', 'otherValue')
|
||||
cache3.set('some', 'thing')
|
||||
|
||||
// cache 1 is a separate cache from cache2 and cache3
|
||||
console.log('cached:', cache.get('key')) // 'value'
|
||||
|
||||
// But they share the same global size
|
||||
console.log(cache.globalSize, 'of', cache.maxSize) // 3 of 3
|
||||
|
||||
cache.set('key2', 'another value')
|
||||
// The cache was full, so one of the existing 3 entries got evicted
|
||||
|
||||
console.log(cache.globalSize, 'of', cache.maxSize) // 3 of 3
|
||||
```
|
||||
|
||||
## API
|
||||
|
||||
#### `const cache = new Rache({ maxSize=65536 })`
|
||||
|
||||
Create a new cache.
|
||||
|
||||
`maxSize` is the maximum amount of entries globally, across this cache and all derived caches (derived with `cache.sub()` or `Rache.from(cache)`).
|
||||
|
||||
#### `const subCache = cache.sub()`
|
||||
|
||||
Create a new cache which shares the global memory limit with the original cache.
|
||||
|
||||
#### `const aCache = Rache.from(cache?)`
|
||||
|
||||
Create a new rache instance.
|
||||
|
||||
If an existing cache is passed in, it will create a sub-cache (equivalent to `aCache = cache.sub()`).
|
||||
|
||||
Otherwise (if no `cache` or a falsy value is passed in), it will create a new cache (equivalent to `aCache = new Rache()`).
|
||||
|
||||
|
||||
#### `cache.globalSize`
|
||||
|
||||
The current amount of entries across all caches.
|
||||
|
||||
#### `cache.maxSize`
|
||||
|
||||
The maximum amount of entries across all caches.
|
||||
|
||||
#### `cache.size`
|
||||
|
||||
The amount of entries in this specific cache.
|
||||
|
||||
#### `cache.set(key, value)`
|
||||
|
||||
Set the key to the given value.
|
||||
|
||||
If the global cache size was at the limit, a random old entry is evicted from the cache.
|
||||
|
||||
#### `cache.delete(key)`
|
||||
|
||||
Delete the entry corresponding to `key`, if any.
|
||||
|
||||
Returns `true` if an entry was deleted, `false` otherwise.
|
||||
|
||||
#### `cache.get(key)`
|
||||
|
||||
Returns the value corresponding to the given key, or `undefined` if there is none.
|
||||
|
||||
#### `cache.keys()`
|
||||
|
||||
Returns an iterator over the keys of this particular cache.
|
||||
|
||||
#### `cache.values()`
|
||||
|
||||
Returns an iterator over the values of this particular cache.
|
||||
|
||||
#### `cache.clear()`
|
||||
|
||||
Clear all entries from this particular cache.
|
||||
|
||||
After clearing, new entries can again be added to the cache.
|
||||
|
||||
#### `cache.destroy()`
|
||||
|
||||
Destroys the cache. The cache should no longer be used after it has been destroyed.
|
||||
+119
@@ -0,0 +1,119 @@
|
||||
class CacheEntry {
|
||||
constructor (key, index, map) {
|
||||
this.key = key
|
||||
this.index = index
|
||||
this.map = map
|
||||
}
|
||||
}
|
||||
|
||||
class CacheValue {
|
||||
constructor (entry, value) {
|
||||
this.entry = entry
|
||||
this.value = value
|
||||
}
|
||||
}
|
||||
|
||||
class Rache {
|
||||
constructor ({ maxSize = 65536, parent = null } = {}) {
|
||||
this.maxSize = parent?.maxSize || maxSize
|
||||
|
||||
this._array = parent?._array || []
|
||||
this._map = new Map()
|
||||
}
|
||||
|
||||
static from (cache) {
|
||||
return cache ? new this({ parent: cache }) : new this()
|
||||
}
|
||||
|
||||
get globalSize () {
|
||||
return this._array.length
|
||||
}
|
||||
|
||||
get size () {
|
||||
return this._map.size
|
||||
}
|
||||
|
||||
sub () {
|
||||
return new Rache({ parent: this })
|
||||
}
|
||||
|
||||
set (key, value) { // ~constant time
|
||||
const existing = this._map.get(key)
|
||||
if (existing !== undefined) {
|
||||
existing.value = value
|
||||
return
|
||||
}
|
||||
|
||||
if (this._array.length >= this.maxSize) this._gc()
|
||||
|
||||
const entry = new CacheEntry(key, this._array.length, this._map)
|
||||
this._array.push(entry)
|
||||
const cacheValue = new CacheValue(entry, value)
|
||||
this._map.set(key, cacheValue)
|
||||
}
|
||||
|
||||
delete (key) {
|
||||
const existing = this._map.get(key)
|
||||
if (existing === undefined) return false
|
||||
|
||||
this._delete(existing.entry.index)
|
||||
return true
|
||||
}
|
||||
|
||||
get (key) {
|
||||
const existing = this._map.get(key)
|
||||
return existing === undefined ? undefined : existing.value
|
||||
}
|
||||
|
||||
* [Symbol.iterator] () {
|
||||
for (const [key, { value }] of this._map) {
|
||||
yield [key, value]
|
||||
}
|
||||
}
|
||||
|
||||
keys () {
|
||||
return this._map.keys()
|
||||
}
|
||||
|
||||
* values () {
|
||||
for (const { value } of this._map.values()) {
|
||||
yield value
|
||||
}
|
||||
}
|
||||
|
||||
clear () {
|
||||
// The entries in map linger on in _array,
|
||||
// so on top of clearing the map, we also kill the ref,
|
||||
// so that any gc running later on the old map won't interfere
|
||||
// (in case a new entry was added with the same key as a cleared entry)
|
||||
|
||||
this._map.clear()
|
||||
this._map = new Map()
|
||||
}
|
||||
|
||||
destroy () {
|
||||
this._map = null
|
||||
this._array = null
|
||||
}
|
||||
|
||||
_gc () {
|
||||
this._delete(Math.floor(Math.random() * this._array.length))
|
||||
}
|
||||
|
||||
_delete (index) { // ~constant time
|
||||
if (index >= this._array.length) throw new Error('Cannot delete unused index (logic bug?)')
|
||||
|
||||
const head = this._array.pop()
|
||||
let removed = head
|
||||
|
||||
if (index < this._array.length) {
|
||||
removed = this._array[index]
|
||||
head.index = index
|
||||
this._array[index] = head
|
||||
}
|
||||
|
||||
removed.map.delete(removed.key)
|
||||
}
|
||||
}
|
||||
|
||||
module.exports = Rache
|
||||
+27
@@ -0,0 +1,27 @@
|
||||
{
|
||||
"name": "rache",
|
||||
"version": "1.0.0",
|
||||
"description": "Random-eviction cache",
|
||||
"main": "index.js",
|
||||
"scripts": {
|
||||
"test": "standard && brittle test.js --coverage"
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "git+https://github.com/holepunchto/rache.git"
|
||||
},
|
||||
"author": "Holepunch",
|
||||
"license": "Apache-2.0",
|
||||
"bugs": {
|
||||
"url": "https://github.com/holepunchto/rache/issues"
|
||||
},
|
||||
"homepage": "https://github.com/holepunchto/rache#readme",
|
||||
"files": [
|
||||
"index.js"
|
||||
],
|
||||
"dependencies": {},
|
||||
"devDependencies": {
|
||||
"brittle": "^3.5.2",
|
||||
"standard": "^17.1.0"
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user