stdlib-js / stdlib-js/stdlib

[RFC]: add `@stdlib/assert/is-complex-string`

未关闭
#1,370 14 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
Accepted difficulty: 2 Feature Good First Issue JavaScript priority: Normal RFC
主要语言
JavaScript
星标
6k
派生
1.3k
平均合并
1 天 3 小时
30 天内合并 PR
611

描述

### Description

This RFC proposes adding package `@stdlib/assert/is-complex-string`.

The package should be similar in structure to [`@stdlib/complex/reviver-float32`](https://github.com/stdlib-js/stdlib/tree/64931c5fdb4abc3a339b619658d3b5acc089e556/lib/node_modules/%40stdlib/complex/reviver-float32).

The goal is to assert if an input string is of a complex number format string`(a + ib)` or `(a+bi)`
where, a and b are numbers

```js
function isComplexString( str ) => boolean
```

Eg : isComplexString( "32+12i" ) returns true
Eg : isComplexString( "32+i12" ) returns true
Eg : isComplexString( null ) returns true
Eg : isComplexString( "" ) returns false
Eg : isComplexString( "abcd+12i" ) returns false
Eg : isComplexString( Infinity ) returns false

> Package: `@stdlib/assert/is-complex-string` Alias: `isComplexString`

### Related Issues

Can help with issues #1332 and #1333

### Questions

This is my first issue so I'd like to know if the way I have proposed the feature is correct

### Other

_No response_

### Checklist

- [X] I have read and understood the [Code of Conduct](https://github.com/stdlib-js/stdlib/blob/develop/CODE_OF_CONDUCT.md).
- [X] Searched for existing issues and pull requests.
- [X] The issue name begins with `RFC:`.

贡献指南

打开贡献指南

调研方向

Start by reviewing lib/node_modules/@stdlib/complex/reviver-float32 and the related issues #1332 and #1333. Clarify the accepted complex-string formats and contradictory examples, especially the null case, before defining what package behavior and completion criteria should be.

由索引模型根据 Issue 内容生成。

评估

技术栈
javascript
领域
tooling
Issue 类型
功能
难度
5/5
预计耗时
一周以上
活跃度
停滞
描述清晰度
基本清楚
新手友好度
35/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。