Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(types): Fix type definition for load().json #2334

Closed
wants to merge 1 commit into from

Conversation

adschm
Copy link
Contributor

@adschm adschm commented Sep 23, 2021

The "json" field in the load() argument object accepts (at least) two
different types of information:

Pattern: [{ [key: string]: string | number }]

json: [
    {name: "www.site1.com", upload: 800, download: 500, total: 400},
]

Pattern: {[key: string]: (string[]|number[])}

json: {
    "data1": [220, 240, 270, 250, 280],
    "data2": [180, 150, 300, 70, 120]
}

In the first case, we need to add "number" to the existing value type for
obvious reasons. In the second case, string might be needed in the
array to provide formatted dates, e.g. "2021-01-01T01:02:03.456"

The "json" field in the load() argument object accepts (at least) two
different types of information:

  Pattern: [{ [key: string]: string | number }]

    json: [
        {name: "www.site1.com", upload: 800, download: 500, total: 400},
    ]

  Pattern: {[key: string]: (string[]|number[])}

    json: {
        "data1": [220, 240, 270, 250, 280],
        "data2": [180, 150, 300, 70, 120]
    }

In the first case, we need to add "number" to the existing value type for
obvious reasons. In the second case, string might be needed in the
array to provide formatted dates, e.g. "2021-01-01T01:02:03.456"

Signed-off-by: Adrian Schmutzler <dev@schmutzler.it>
@coveralls
Copy link

Coverage Status

Coverage remained the same at 89.949% when pulling a9771dc on adschm:types-json into 1ce7333 on naver:master.

@netil netil added the type.d Type definition related label Sep 24, 2021
@netil netil closed this in 25ebb78 Sep 27, 2021
@netil
Copy link
Member

netil commented Sep 27, 2021

@adschm thanks for the contribution!

github-actions bot pushed a commit that referenced this pull request Oct 1, 2021
# [3.2.0-next.6](3.2.0-next.5...3.2.0-next.6) (2021-10-01)

### Bug Fixes

* **types:** Allow string dates for zoom() domain ([9cae479](9cae479)), closes [#2316](#2316) [#2333](#2333)
* **types:** Fix type definition for load().json ([25ebb78](25ebb78)), closes [#2334](#2334)

### Features

* **event:** add option for step-before/step-after charts for tooltip to match step behavior ([5f664ba](5f664ba)), closes [#2332](#2332)
@adschm adschm deleted the types-json branch October 5, 2021 12:00
github-actions bot pushed a commit that referenced this pull request Oct 7, 2021
# [3.2.0](3.1.5...3.2.0) (2021-10-07)

### Bug Fixes

* **axis:** fix y axis stepSize value ([18f6f27](18f6f27)), closes [#2294](#2294)
* **bar:** fix data label to be shown for 0 values ([f3634ee](f3634ee)), closes [#2251](#2251)
* **event:** make consistent tooltip position on step-after ([5d3a5ed](5d3a5ed)), closes [#2287](#2287)
* **gauge:** fix error when interaction=false ([cc4a5e7](cc4a5e7)), closes [#2351](#2351)
* **grid:** Make grid elements pass through pointer events ([4db1bcd](4db1bcd)), closes [#2355](#2355)
* **grid:** pPrevent error throw  ([8fcf61c](8fcf61c)), closes [#2310](#2310)
* **plugin:** fix textoverlap plugin ([5e486b5](5e486b5)), closes [#1144](#1144)
* **subchart:** fix subchart esm import failure ([ba6c2b5](ba6c2b5)), closes [#2255](#2255)
* **tooltip:** fix tooltip.position call context ([b78a48d](b78a48d)), closes [#2265](#2265)
* **types:** Allow string dates for zoom() domain ([9cae479](9cae479)), closes [#2316](#2316) [#2333](#2333)
* **types:** fix data.onshown/hidden types ([3721c4c](3721c4c)), closes [#2270](#2270) [#2275](#2275)
* **types:** Fix type definition for load().json ([25ebb78](25ebb78)), closes [#2334](#2334)
* **types:** Fix wrong type definition ([5f7779b](5f7779b)), closes [#2316](#2316)
* **zoom:** Fix error throw on drag zoom interaction ([f1dcb27](f1dcb27)), closes [#2343](#2343)
* **zoom:** fix zoom event triggering for drag type ([0a0f039](0a0f039)), closes [#2254](#2254)
* **zoom:** Fix zoomend call on .zoom()  ([9515565](9515565)), closes [#2217](#2217) [#2254](#2254)

### Features

* **axis:** Enhance padding to accept px value ([769ec8f](769ec8f)), closes [#2246](#2246)
* **error:** Enhance error logging for ESM import ([4b5119c](4b5119c)), closes [#2311](#2311)
* **event:** add option for step-before/step-after charts for tooltip to match step behavior ([5f664ba](5f664ba)), closes [#2332](#2332)
* **module:** Support dual CJS/ESM package ([ddd8977](ddd8977)), closes [#2202](#2202)
* **plugin:** Intent to ship sparkline ([091284e](091284e)), closes [#2285](#2285)
* **plugin:** Intent to ship TableView plugin ([6f07e94](6f07e94)), closes [#1873](#1873)
* **Subchart:** add subchart x axis tick format option ([da2f3ff](da2f3ff)), closes [#2314](#2314)
* **tooltip:** Enhance tooltip.position passing curr pos ([ec783e9](ec783e9)), closes [#2267](#2267)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type.d Type definition related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants