From 8bb2b1bb766ac9dc7fcfa189d6391be05a714d36 Mon Sep 17 00:00:00 2001 From: Simon Warta Date: Tue, 4 Aug 2020 11:38:48 +0200 Subject: [PATCH] Improve docs of isNonNullObject --- packages/utils/src/typechecks.ts | 7 ++++++- packages/utils/types/typechecks.d.ts | 7 ++++++- 2 files changed, 12 insertions(+), 2 deletions(-) diff --git a/packages/utils/src/typechecks.ts b/packages/utils/src/typechecks.ts index 664fcc53..40faa05d 100644 --- a/packages/utils/src/typechecks.ts +++ b/packages/utils/src/typechecks.ts @@ -1,5 +1,10 @@ /** - * Checks if data is a non-null object (i.e. matches the TypeScript object type) + * Checks if data is a non-null object (i.e. matches the TypeScript object type). + * + * Note: this returns true for arrays, which are objects in JavaScript + * even though array and object are different types in JSON. + * + * @see https://www.typescriptlang.org/docs/handbook/basic-types.html#object */ export function isNonNullObject(data: unknown): data is object { return typeof data === "object" && data !== null; diff --git a/packages/utils/types/typechecks.d.ts b/packages/utils/types/typechecks.d.ts index 3e911797..68c29628 100644 --- a/packages/utils/types/typechecks.d.ts +++ b/packages/utils/types/typechecks.d.ts @@ -1,5 +1,10 @@ /** - * Checks if data is a non-null object (i.e. matches the TypeScript object type) + * Checks if data is a non-null object (i.e. matches the TypeScript object type). + * + * Note: this returns true for arrays, which are objects in JavaScript + * even though array and object are different types in JSON. + * + * @see https://www.typescriptlang.org/docs/handbook/basic-types.html#object */ export declare function isNonNullObject(data: unknown): data is object; /**