diff --git a/index.d.ts b/index.d.ts new file mode 100644 index 0000000..cecfe54 --- /dev/null +++ b/index.d.ts @@ -0,0 +1,43 @@ +declare module 'osmose-request' { + + export interface Item { + id: number; + name: string; + tags: string[]; + count: number[] | null; + levels: number[]; + } + + export interface Category { + id: number; + name: string; + items: Item[]; + } + + export interface Error { + [key: string]: string; + } + + export interface Options { + language?: string; + endpoint?: string; + } + + export default class OsmoseRequest { + constructor(options?: Options); + + closeError(errorId: number | string): Promise; + + falseError(errorId: number | string): Promise; + + fetchError(errorId: number | string): Promise; + + fetchErrors(params: {}): Promise; + + fetchItemCategories(): Promise; + + fetchItems(isoCountryCode?: string): Promise; + + fetchSupportedCountries(): string[]; + } +} \ No newline at end of file diff --git a/package.json b/package.json index a27ad57..3d6dbb6 100644 --- a/package.json +++ b/package.json @@ -17,8 +17,10 @@ "api" ], "main": "dist/OsmoseRequest.js", + "types": "index.d.ts", "files": [ - "dist" + "dist", + "index.d.ts" ], "scripts": { "watch": "webpack -w --progress",