mirror of
https://github.com/elastic/kibana.git
synced 2025-06-27 18:51:07 -04:00
Wrap rison-node to improve types (#146649)
@maximpn brought up the issues caused by the types required by the rison-node package, which attempted to communicate that "encoded values must be primitive values, or recursive arrays/object of primitive values". This isn't actually expressible in TypeScript, which lead to many instances of `rison.encode(value as unknown as RisonValue)` which is useless. Additionally, the rison-node library actually supports any value and will either produce valid rison or `undefined` for that value. To address this I'm adding a wrapper function which accepts `any` and returns a `string`. If rison-node is totally unable to produce any rison for the value (because the value is `undefined` or some other type like Symbol or BigInt) the `encode()` function will throw. If you're accepting arbitrary input you can use the `encodeUnknown()` function, which will return a string or undefined, if the value you provided has zero rison representation. Like JSON.stringify() any non-circular primitive, object, or array can be encoded with either function. If the values within those objects are not encodable (functions, RegExps, etc) then they will be skipped. Any object/array with the `toJSON()` method will be converted to JSON first, and if the prototype of the object has the `encode_rison()` method it will be used to convert he value into rison. The changes in this PR are mostly updating usage of rison-node to use `@kbn/rison` (which is also enforced by eslint). There are also several changes which remove unnecessary casting.
This commit is contained in:
parent
6f7c6ad947
commit
2e314db2ce
82 changed files with 491 additions and 144 deletions
|
@ -62,7 +62,6 @@ RUNTIME_DEPS = [
|
|||
"@npm//react-router-dom",
|
||||
"@npm//react-router",
|
||||
"@npm//react",
|
||||
"@npm//rison-node",
|
||||
"@npm//rxjs",
|
||||
"@npm//styled-components",
|
||||
"@npm//symbol-observable",
|
||||
|
@ -98,7 +97,6 @@ TYPES_DEPS = [
|
|||
"@npm//react-is",
|
||||
"@npm//react-router",
|
||||
"@npm//react-router-dom",
|
||||
"@npm//rison-node",
|
||||
"@npm//rxjs",
|
||||
"@npm//styled-components",
|
||||
"@npm//symbol-observable",
|
||||
|
|
|
@ -100,7 +100,6 @@ module.exports = (_, argv) => {
|
|||
'react-router-dom',
|
||||
'react-router',
|
||||
'react',
|
||||
'rison-node',
|
||||
'rxjs',
|
||||
'rxjs/operators',
|
||||
'styled-components',
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue