[lookup-by-path] Exclude null

microsoft · Dec 18, 2024 · 6deecb7 · 6deecb7
1 parent ae94f6c
commit 6deecb7
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 8 deletions.
diff --git a/common/changes/@rushstack/lookup-by-path/lookup-enhancements_2024-12-17-22-37.json b/common/changes/@rushstack/lookup-by-path/lookup-enhancements_2024-12-17-22-37.json
@@ -2,7 +2,7 @@
   "changes": [
     {
       "packageName": "@rushstack/lookup-by-path",
-      "comment": "Update all methods to accept optional override delimiters. Add `size`, `entries(), `get()`, `has()`, `removeItem()`. Make class iterable.\nExplicitly exclude `undefined` from the allowed types for the type parameter `TItem`.",
+      "comment": "Update all methods to accept optional override delimiters. Add `size`, `entries(), `get()`, `has()`, `removeItem()`. Make class iterable.\nExplicitly exclude `undefined` and `null` from the allowed types for the type parameter `TItem`.",
       "type": "minor"
     }
   ],

diff --git a/common/reviews/api/lookup-by-path.api.md b/common/reviews/api/lookup-by-path.api.md
@@ -5,14 +5,14 @@
 ```ts
 
 // @beta
-export interface IPrefixMatch<TItem extends {} | null> {
+export interface IPrefixMatch<TItem extends {}> {
     index: number;
     lastMatch?: IPrefixMatch<TItem>;
     value: TItem;
 }
 
 // @beta
-export interface IReadonlyLookupByPath<TItem extends {} | null> extends Iterable<[string, TItem]> {
+export interface IReadonlyLookupByPath<TItem extends {}> extends Iterable<[string, TItem]> {
     [Symbol.iterator](query?: string, delimiter?: string): IterableIterator<[string, TItem]>;
     entries(query?: string, delimiter?: string): IterableIterator<[string, TItem]>;
     findChildPath(childPath: string, delimiter?: string): TItem | undefined;
@@ -25,7 +25,7 @@ export interface IReadonlyLookupByPath<TItem extends {} | null> extends Iterable
 }
 
 // @beta
-export class LookupByPath<TItem extends {} | null> implements IReadonlyLookupByPath<TItem> {
+export class LookupByPath<TItem extends {}> implements IReadonlyLookupByPath<TItem> {
     [Symbol.iterator](query?: string, delimiter?: string): IterableIterator<[string, TItem]>;
     constructor(entries?: Iterable<[string, TItem]>, delimiter?: string);
     clear(): this;

diff --git a/libraries/lookup-by-path/src/LookupByPath.ts b/libraries/lookup-by-path/src/LookupByPath.ts
@@ -4,7 +4,7 @@
 /**
  * A node in the path trie used in LookupByPath
  */
-interface IPathTrieNode<TItem extends {} | null> {
+interface IPathTrieNode<TItem extends {}> {
   /**
    * The value that exactly matches the current relative path
    */
@@ -31,7 +31,7 @@ interface IPrefixEntry {
  *
  * @beta
  */
-export interface IPrefixMatch<TItem extends {} | null> {
+export interface IPrefixMatch<TItem extends {}> {
   /**
    * The item that matched the prefix
    */
@@ -51,7 +51,7 @@ export interface IPrefixMatch<TItem extends {} | null> {
  *
  * @beta
  */
-export interface IReadonlyLookupByPath<TItem extends {} | null> extends Iterable<[string, TItem]> {
+export interface IReadonlyLookupByPath<TItem extends {}> extends Iterable<[string, TItem]> {
   /**
    * Searches for the item associated with `childPath`, or the nearest ancestor of that path that
    * has an associated item.
@@ -178,7 +178,7 @@ export interface IReadonlyLookupByPath<TItem extends {} | null> extends Iterable
  * ```
  * @beta
  */
-export class LookupByPath<TItem extends {} | null> implements IReadonlyLookupByPath<TItem> {
+export class LookupByPath<TItem extends {}> implements IReadonlyLookupByPath<TItem> {
   /**
    * The delimiter used to split paths
    */