Add TypeScript typings #54
Conversation
take it or leave it
| * _string_) to remove all `any` usages. | ||
| */ | ||
|
|
||
| declare type HarfbuzzPointer = string; |
| ax: number; | ||
| ay: number; | ||
| dx: number; | ||
| dy: number; |
There was a problem hiding this comment.
Can you add flags: number; (recently added, not yet released)?
| ptr: HarfbuzzPointer; | ||
| addText: (text: string) => void; | ||
| guessSegmentProperties: () => | ||
| any; // any = return of exports.hb_buffer_guess_segment_properties(ptr) |
There was a problem hiding this comment.
The C++ hb_buffer_guess_segment_properties returns void, this can just be void too
| setLanguage: (language: string) => void; | ||
| setScript: (script: string) => void; | ||
| setClusterLevel: (level: number) => void; | ||
| json: (font?: HarfbuzzFont) => { |
There was a problem hiding this comment.
This function doesn't have an argument, should just be ()
| (font: HarfbuzzFont, buffer: HarfbuzzBuffer, features: string, | ||
| stop_at: number, stop_phase: number) => HarfbuzzJson; | ||
| } | ||
| declare function hbjs(instance: HarfbuzzModule): HarfbuzzJs; |
There was a problem hiding this comment.
Most people will be doing require('harfbuzzjs'), but this doesn't appear to make that typed. It looks like it's for require('./hbjs'). Does there need to be another file index.d.ts?
I tried a few things but couldn't get hbjs.d.ts to work (for example correct hover types in VS Code). If it helps, a while ago I wrote my own types via a root-level types.d.ts that looks like this:
declare namespace HarfBuzzJsInit {
type HbFace = {};
...
type Harfbuzz = {
createBlob
...
};
}
// declaring a const with the same name as the namespace above
// lets people do `import {HbFace} from 'harfbuzzjs'
declare const HarfbuzzJsInit: Promise<HarfBuzzJsInit.HarfBuzz>;
export = HarfBuzzJsInit;
|
cc @ebraminio |
|
I think this one can be closed since it has problems and the author said "take it or leave it" 🙂 |
take it or leave it