[OV JS] Add TS definition for AnyMap #26711
Conversation
src/bindings/js/node/lib/addon.ts
Outdated
| @@ -21,6 +21,12 @@ type elementTypeString = | |||
| | 'f32' | |||
| | 'string'; | |||
|
|
|||
| type Any = string | number | boolean; | |||
There was a problem hiding this comment.
I propose to choose different name, because Any crosses with any in TypeScript definition.
It can be longer, but cleaner, for example: AllowedPropertyType, ConfigPropertyType, etc
There was a problem hiding this comment.
I updated the PR description and I think the best name will be OVAny
src/bindings/js/node/lib/addon.ts
Outdated
| type AnyMap = { | ||
| [propertyName: string]: Any; | ||
| }; |
There was a problem hiding this comment.
| type AnyMap = { | |
| [propertyName: string]: Any; | |
| }; | |
| type AnyMap = Record<string, *AnyNewName*>; |
https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type
There was a problem hiding this comment.
Also, propose to replace AnyMap name
There was a problem hiding this comment.
Or just explicitly add Record type in the place, where it uses.
Because our goal not to map values between C++ and JS sides, we should help developers by giving hints.
For AnyMap it looks like:
If specify inline, it will give clearer hint:
There was a problem hiding this comment.
I removed definition of AnyMap. Agree that built-in Record type is a simpler way to represent a map of string keys to OVAny values and provides better hints.
### Details: - Add definition of `OVAny` to `addon.ts` to encapsulate the concept of [ov::Any](https://docs.openvino.ai/2024/api/c_cpp_api/classov_1_1_any.html) from C++ API in a way that's clear and can be easily updated if the underlying C++ type changes. Improved readability and maintainability. -- 'OVAny' corresponds to Python API [OVAny](https://docs.openvino.ai/2024/api/ie_python_api/_autosummary/openvino.OVAny.html) - In future updates to Node.js API, the OVAny type is expected to be enhanced with additional functionality. - Missed linter changes to `core.test.js` due to upstream merges ### Tickets: - [CVS-149319](https://jira.devtools.intel.com/browse/CVS-149319)
Details:
OVAnytoaddon.tsto encapsulate the concept of ov::Any from C++ API in a way that's clear and can be easily updated if the underlying C++ type changes. Improved readability and maintainability.-- 'OVAny' corresponds to Python API OVAny
core.test.jsdue to upstream mergesTickets: