[RFC]: add `@stdlib/assert/is-ragged-nested-array`

[kgryte]

Description

This RFC proposes adding the package @stdlib/assert/is-ragged-nested-array.

The package should be similar in structure to @stdlib/assert/is-array-like-object.

A ragged nested array is a nested array having inner dimensions of varying lengths. E.g.,

[
  [ 1, 2, 3 ],
  [ 4, 5 ]
]

is a ragged nested array.

function isRaggedNestedArray( value ) { ... }

Package: @stdlib/assert/is-ragged-nested-array
Alias: isRaggedNestedArray

Related Issues

None.

Questions

• Should this package only check for two-dimensional ragged arrays (i.e., an array of arrays)? Or should it recurse and check at each potential inner nested array depth?

Answer: we should only support two-dimensional nested arrays.

• Should we require strict Array instances or are array-like objects okay?

Answer: we should not use isArray, but isArrayLikeObject. In order for a value to be a nested ragged array, the input value must be an array-like object and each element must be an array-like object and at least one element must have a length which differs from another element.

Other

No.

Checklist

• I have read and understood the Code of Conduct.
• Searched for existing issues and pull requests.
• The issue name begins with RFC:.

[performant23]

Hey @kgryte, I can take this up and have reviewed the feature and also the package, 'is-array-like-object'! Could you please assign me this issue?

[kgryte]

Thanks for volunteering to work on this, @performant23. Please feel free to submit a PR implementing this feature.

[performant23]

Hello @kgryte, hope you're doing well! Just to confirm and ensure I don't take any conditions for granted, when we say an array is a ragged nested array, are we considering it the exclusive sense (with only arrays having different lengths are allowed or do we allow some or all the arrays inside the main array to have same lengths)?

Edit: Actually nevermind, got it! The description says, "at least one element must have a length which differs from another element" - I must have overlooked

[Ruwaid884]

@kgryte i want to contribute to this issue could you also assign me this please

[performant23]

Hey, @Ruwaid884 , actually I'm done with the feature and am just testing it.

[Ruwaid884]

@performant23, okay sounds nice
but i feel it is a good first issue this will give me the understanding of the code how it is being written by the developers. i will also be working on this issue just to get grasp of the codebase.