diff --git a/CHANGELOG.md b/CHANGELOG.md index 387f4a3..ed46d5d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,7 @@ Notable changes to this project are documented in this file. The format is based Breaking changes: New features: +- Add `isEmpty` (#222 by @sigma-andex) Bugfixes: diff --git a/src/Data/Array.purs b/src/Data/Array.purs index 6bc035a..1335ffe 100644 --- a/src/Data/Array.purs +++ b/src/Data/Array.purs @@ -37,6 +37,7 @@ module Data.Array , many , null + , isEmpty , length , (:), cons @@ -217,13 +218,21 @@ many v = some v <|> pure [] -- Array size ------------------------------------------------------------------ -------------------------------------------------------------------------------- --- | Test whether an array is empty. +-- | Test whether an array is empty. Alias for `isEmpty`. -- | ```purescript -- | null [] = true -- | null [1, 2] = false -- | ``` null :: forall a. Array a -> Boolean -null xs = length xs == 0 +null = isEmpty + +-- | Test whether an array is empty. +-- | ```purescript +-- | isEmpty [] = true +-- | isEmpty [1, 2] = false +-- | ``` +isEmpty :: forall a. Array a -> Boolean +isEmpty xs = length xs == 0 -- | Get the number of elements in an array. -- | ```purescript diff --git a/test/Test/Data/Array.purs b/test/Test/Data/Array.purs index 9325c0f..eb8bfac 100644 --- a/test/Test/Data/Array.purs +++ b/test/Test/Data/Array.purs @@ -49,12 +49,12 @@ testArray = do -- some -- many - log "null should return false for non-empty arrays" - assert $ A.null [1] == false - assert $ A.null [1, 2, 3] == false + log "isEmpty should return false for non-empty arrays" + assert $ A.isEmpty [1] == false + assert $ A.isEmpty [1, 2, 3] == false - log "null should return true for an empty array" - assert $ A.null nil == true + log "isEmpty should return true for an empty array" + assert $ A.isEmpty nil == true log "length should return the number of items in an array" assert $ A.length nil == 0