loudo-ds-map-interfaces 0.0.1

package/LICENSE.txt

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2024, p-jack
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -0,0 +1,3 @@
+# loudo-ds-map-interfaces
+
+Provides mixins for maps.

package/dist/index.d.ts

@@ -0,0 +1,24 @@
+import { Tin } from "loudo-ds-core";
+export interface Entry<K extends {}, V extends {}> {
+    key: K;
+    value: V;
+}
+export declare abstract class BaseMap<K extends {}, V extends {}> {
+    abstract get(key: K): V | undefined;
+    abstract get keyEq(): (k1: K, k2: K) => boolean;
+    hasKey(key: K): boolean;
+    get keys(): Tin<K>;
+    get values(): Tin<V>;
+}
+export interface BaseMap<K extends {}, V extends {}> extends Tin<Entry<K, V>> {
+}
+export declare abstract class MapChange<K extends {}, V extends {}> {
+    abstract put(key: K): V | undefined;
+}
+export interface MapChange<K extends {}, V extends {}> extends BaseMap<K, V> {
+}
+export declare abstract class MapRemove<K extends {}, V extends {}> {
+    abstract remove(key: K): V | undefined;
+}
+export interface MapRemove<K extends {}, V extends {}> extends BaseMap<K, V> {
+}

package/dist/index.js

@@ -0,0 +1,14 @@
+import { Tin, mixin } from "loudo-ds-core";
+export class BaseMap {
+    hasKey(key) { return this.get(key) !== undefined; }
+    get keys() { return this.map(x => x.key); }
+    get values() { return this.map(x => x.value); }
+}
+mixin(BaseMap, [Tin]);
+export class MapChange {
+}
+mixin(MapChange, [BaseMap]);
+export class MapRemove {
+}
+mixin(MapRemove, [BaseMap]);
+//# sourceMappingURL=index.js.map

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "loudo-ds-map-interfaces",
+  "type": "module",
+  "version": "0.0.1",
+  "description": "Core interfaces for loud maps (dictionaries.)",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "README.md",
+    "dist/index.js",
+    "dist/index.d.ts"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "prepare": "tsc",
+    "test": "vitest --coverage"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/p-jack/loudo-ds-core.git"
+  },
+  "author": "Paul Jack",
+  "license": "BSD-3-Clause",
+  "bugs": {
+    "url": "https://github.com/p-jack/loudo-ds-core/issues"
+  },
+  "homepage": "https://github.com/p-jack/loudo-ds-core#readme",
+  "devDependencies": {
+    "@vitest/coverage-v8": "^1.2.2",
+    "typescript": "^5.3.3",
+    "vitest": "^1.2.2"
+  },
+  "dependencies": {
+    "loudo-ds-core": "^0.0.20"
+  }
+}