From 9032eae03ed21da62de81971bc7e89d4eb47facd Mon Sep 17 00:00:00 2001 From: CRBroughton Date: Wed, 15 May 2024 19:30:46 +0100 Subject: [PATCH] docs: :memo: update remaining mis-spellings of IsArray to match new implementation --- README.md | 4 ++-- tests/isArray.test.ts | 6 +++--- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 58ef954..3e37bc7 100644 --- a/README.md +++ b/README.md @@ -8,8 +8,8 @@ A collection of helper TypeScript types to test other TypeScript types. This col - Excludes - Check if a type doesn't contain another type - Includes - Check if a type includes another type - Extends - Check if one type is extending another type -- isArray - Checks if a type is an array -- isNotArray - Checks if a type is not an array +- IsArray - Checks if a type is an array +- IsNotArray - Checks if a type is not an array - Length - Check a given types length; Combine this with the 'Equals' type checker - Position - Returns a type in the given position of an array; Combine this with the 'Equals' type checker - IsNullable - Check if a type is nullable diff --git a/tests/isArray.test.ts b/tests/isArray.test.ts index 81f6c62..4aca38e 100644 --- a/tests/isArray.test.ts +++ b/tests/isArray.test.ts @@ -2,12 +2,12 @@ import { describe, it } from 'bun:test' import type { Expect, IsArray } from '../index' -describe('isArray tests', () => { - it('Passes the isArray test when the type is an array', () => { +describe('IsArray tests', () => { + it('Passes the IsArray test when the type is an array', () => { type Result = Expect> // ^? }) - it('Failed the isArray test when the type is not an array', () => { + it('Failed the IsArray test when the type is not an array', () => { // @ts-expect-error - Fails the exclusion type Result = Expect> // ^?