Skip to content

fix has and use undefined instead of null #147

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Mara-Li wants to merge 6 commits into
base: main
Choose a base branch
from
Open

fix has and use undefined instead of null #147

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
04bf70c
refactor: use undefined
Mara-Li Jan 25, 2026
4b07280
fix: `has` doesn't works with path.
Mara-Li Jan 26, 2026
3a2acfb
fix: use `Path<V>` for the dot notation
Mara-Li Jan 27, 2026
2f95f0c
fix: test to use undefined instead of null
Mara-Li Jan 27, 2026
ba3cc39
test: add nested path test
Mara-Li Jan 28, 2026
a48a5d8
test: add more test around has and subpath key
Mara-Li Jan 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 35 additions & 19 deletions src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -229,10 +229,10 @@ export default class Enmap<V = any, SV = unknown> {
*
* const someSubValue = enmap.get("anObjectKey", "someprop.someOtherSubProp");
*/
get(key: string): V | null;
get<P extends Path<V>>(key: string, path: P): PathValue<V, P> | null;
get<P extends Path<V>>(key: string, path: P | undefined): V | PathValue<V, P> | null;
get<P extends Path<V>>(key: string, path?: P): V | PathValue<V, P> | null {
get(key: string): V | undefined;
get<P extends Path<V>>(key: string, path: P): PathValue<V, P> | undefined;
get<P extends Path<V>>(key: string, path: P | undefined): V | PathValue<V, P> | undefined;
get<P extends Path<V>>(key: string, path?: P): V | PathValue<V, P> | undefined {
this.#keycheck(key);

if (!isNil(this.#autoEnsure) && !this.has(key)) {
Expand All @@ -242,8 +242,8 @@ export default class Enmap<V = any, SV = unknown> {
const data = this.#db
.prepare(`SELECT value FROM ${this.#name} WHERE key = ?`)
.get(key) as { value: string } | undefined;
const parsed = data ? this.#parse(data.value, key) : null;
if (isNil(parsed)) return null;
const parsed = data ? this.#parse(data.value, key) : undefined;
if (isNil(parsed)) return undefined;

if (path) {
this.#check(key, ['Object']);
Expand All @@ -254,19 +254,35 @@ export default class Enmap<V = any, SV = unknown> {

/**
* Returns whether or not the key exists in the Enmap.
* @param key Required. The key of the element to add to The Enmap or array.
* @param {string} key Required. The key of the element to add to The Enmap or array.
* @param {Path<V>} path Optional. The name of the property to check inside the object or array.
* Should be a path with dot notation, such as "prop1.subprop2.subprop3"
* @example
* if(enmap.has("myKey")) {
* // key is there
* }
*
* if(!enmap.has("myOtherKey", "oneProp.otherProp.SubProp")) return false;
* @returns {boolean}
*/
has(key: string): boolean {
has(key: string, path?: Path<V>): boolean {
this.#keycheck(key);

// Check if the key exists
const data = this.#db
.prepare(`SELECT count(*) FROM ${this.#name} WHERE key = ?`)
.get(key) as { 'count(*)': number };
return data['count(*)'] > 0;

if (data['count(*)'] === 0) return false;

// If path is provided, check if the path exists within the value
if (path) {
this.#check(key, ['Object']);
const value = this.get(key);
return _get(value, path) !== undefined;
}

return true;
}

/**
Expand Down Expand Up @@ -508,7 +524,7 @@ export default class Enmap<V = any, SV = unknown> {
operation: MathOps,
operand: number,
path?: Path<V>,
): number | null {
): number | undefined {
this.#keycheck(key);
this.#check(key, ['Number'], path);
const data = this.get(key, path);
Expand Down Expand Up @@ -580,17 +596,17 @@ export default class Enmap<V = any, SV = unknown> {
* console.log(settings) // enmap's value for "1234567890" if it exists, otherwise the defaultSettings value.
* @return {*} The value from the database for the key, or the default value provided for a new key.
*/
ensure(key: string, defaultValue: any): V | null;
ensure(key: string, defaultValue: any): V | undefined;
ensure<P extends Path<V>>(
key: string,
defaultValue: any,
path: P,
): PathValue<V, P> | null;
): PathValue<V, P> | undefined;
ensure<P extends Path<V>>(
key: string,
defaultValue: any,
path?: P,
): V | PathValue<V, P> | null {
): V | PathValue<V, P> | undefined {
this.#keycheck(key);

if (!isNil(this.#autoEnsure)) {
Expand Down Expand Up @@ -911,7 +927,7 @@ export default class Enmap<V = any, SV = unknown> {
find(
pathOrFn: ((val: V, key: string) => boolean) | string,
value?: any,
): V | null {
): V | undefined {
const stmt = this.#db.prepare(`SELECT key, value FROM ${this.#name}`);
for (const row of stmt.iterate() as IterableIterator<{
key: string;
Expand All @@ -925,7 +941,7 @@ export default class Enmap<V = any, SV = unknown> {
return parsed;
}
}
return null;
return undefined;
}

/**
Expand All @@ -943,7 +959,7 @@ export default class Enmap<V = any, SV = unknown> {
findIndex(
pathOrFn: ((val: V, key: string) => boolean) | string,
value?: any,
): string | null {
): string | undefined {
const stmt = this.#db.prepare(`SELECT key, value FROM ${this.#name}`);
for (const row of stmt.iterate() as IterableIterator<{
key: string;
Expand All @@ -957,7 +973,7 @@ export default class Enmap<V = any, SV = unknown> {
return row.key;
}
}
return null;
return undefined;
}

/**
Expand Down Expand Up @@ -1207,7 +1223,7 @@ export default class Enmap<V = any, SV = unknown> {
}
}

#math(base: number, op: MathOps, opand: number): number | null {
#math(base: number, op: MathOps, opand: number): number | undefined {
if (base == undefined || op == undefined || opand == undefined)
throw new Err(
'Math Operation requires base and operation',
Expand Down Expand Up @@ -1242,6 +1258,6 @@ export default class Enmap<V = any, SV = unknown> {
case 'random':
return Math.floor(Math.random() * Math.floor(opand));
}
return null;
return undefined;
}
}
36 changes: 26 additions & 10 deletions test/index.spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,10 +107,10 @@ describe('Enmap', () => {
expect(enmap.get('setNumber')).toBe(1);
});

test('should set a value w/ null', () => {
enmap.set('setNull', null);
test('should set a value w/ undefined', () => {
enmap.set('setNull', undefined);

expect(enmap.get('setNull')).toBe(null);
expect(enmap.get('setNull')).toBe(undefined);
});

test('should set a value w/ boolean', () => {
Expand Down Expand Up @@ -380,7 +380,7 @@ describe('Enmap', () => {
enmap.set('huh', 1);
enmap.math('huh', 'huh', 1);

expect(enmap.get('huh')).toBe(null);
expect(enmap.get('huh')).toBe(undefined);
});

test('should math value w/ path', () => {
Expand Down Expand Up @@ -484,9 +484,25 @@ describe('Enmap', () => {
expect(enmap.has('has')).toBe(true);
});

test('should return true if key and path exists', () =>{
enmap.set('hasPath', 'value', 'nested');

expect(enmap.has('hasPath', 'nested')).toBe(true);
});

test("should return false if key doesn't exist", () => {
expect(enmap.has('unknown')).toBe(false);
});

test("Should return false if the subkey doesn't exists", () => {
enmap.set('hasPath2', undefined, 'nested');
expect(enmap.has('hasPath2', 'nested')).toBe(false);
});

test("should return false if key exists but path doesn't", () => {
enmap.set('hasPath3', 'value', 'nested');
expect(enmap.has('hasPath3', 'other')).toBe(false);
});
});

describe('includes', () => {
Expand All @@ -512,7 +528,7 @@ describe('Enmap', () => {
enmap.set('delete', 'value');
enmap.delete('delete');

expect(enmap.get('delete')).toBe(null);
expect(enmap.get('delete')).toBe(undefined);
});

test('should delete a path', () => {
Expand All @@ -530,7 +546,7 @@ describe('Enmap', () => {
enmap.set('clear', 'value');
enmap.clear();

expect(enmap.get('clear')).toBe(null);
expect(enmap.get('clear')).toBe(undefined);
});
});

Expand Down Expand Up @@ -827,11 +843,11 @@ describe('Enmap', () => {
expect(enmap.find('sub', 'value')).toEqual({ sub: 'value' });
});

test('should return null if not found', () => {
test('should return undefined if not found', () => {
enmap.set('find', 'value');
enmap.set('find2', 'value2');

expect(enmap.find((val) => val === 'value3')).toBe(null);
expect(enmap.find((val) => val === 'value3')).toBe(undefined);
});
});

Expand All @@ -852,11 +868,11 @@ describe('Enmap', () => {
expect(enmap.findIndex('sub', 'value')).toBe('find');
});

test('should return null if not found', () => {
test('should return undefined if not found', () => {
enmap.set('find', 'value');
enmap.set('find2', 'value2');

expect(enmap.findIndex((val) => val === 'value3')).toBe(null);
expect(enmap.findIndex((val) => val === 'value3')).toBe(undefined);
});
});

Expand Down