Some type definitions [Typescript]

[lelukas]

I created types for the parse function. I'm only using this one in my application. If it helps, here it goes.

If you're new to Typescript:
Create a .d.ts file inside a folder and reference that folder in your tsconfig.json file by editing the typeRoots array.
Example:

"typeRoots": ["src/customTypings"],

while having src > customTypings > himalaya.d.ts

declare module 'himalaya' {
  export function parse(str: string, options?: any): Array<AnyElement>

  export type Type = "element" | "comment" | "text"

  export interface Node {
    type: Type;
  }

  export interface Attribute {
    key: string;
    value: string | null;
  }

  export interface Element extends Node {
    type: "element";
    tagName: string;
    children: AnyElement[];
    attributes: Attribute[];
  }

  export interface Comment extends Node {
    type: "comment";
    content: string;
  }

  export interface Text extends Node {
    type: "text";
    content: string;
  }

  export type AnyElement = Element | Comment | Text
}

[mparpaillon]

Very useful thanks.
I would probably deduce the type from the nodes though. Something like

declare module 'himalaya' {
  export interface Attribute {
    key: string;
    value: string | null;
  }

  export interface Element {
    type: "element";
    tagName: string;
    children: Node[];
    attributes: Attribute[];
  }

  export interface Comment {
    type: "comment";
    content: string;
  }

  export interface Text {
    type: "text";
    content: string;
  }

  export type Node = Element | Comment | Text;

  export function parse(str: string, options?: any): Node[]
  export function stringify(elements: Node[]): string
}