Improve: TypeScript annotations

unum-cloud / usearch

Fast Open-Source Search & Clustering engine × for Vectors & 🔜 Strings × in C++, C, Python, JavaScript, Rust, Java, Objective-C, Swift, C#, GoLang, and Wolfram 🔍

https://unum-cloud.github.io/usearch/

Apache License 2.0

2.27k stars 142 forks source link

Improve: TypeScript annotations #309

Closed jlarmstrongiv closed 1 year ago

jlarmstrongiv commented 1 year ago

Referenced

Generating types from JSDoc https://www.typescriptlang.org/docs/handbook/declaration-files/dts-from-js.html
JSDoc object types https://stackoverflow.com/a/31573441

ashvardanian commented 1 year ago

:tada: This PR is included in version 2.8.12 :tada:

The release is available on GitHub release

Your semantic-release bot :package::rocket:

jlarmstrongiv commented 1 year ago

@ashvardanian I made a mistake in the typings—all of the dimensionsOrConfigs object properties are required, when only dimensions needs to be required. Do you know how to make them optional with JSDoc?

Other than that one quirk, the types work great 👍

ashvardanian commented 1 year ago

@jlarmstrongiv, sadly not familiar with that.