From dc8a04406244741453ee47c4e1a167b804011964 Mon Sep 17 00:00:00 2001 From: Bart Duisters <43420049+bartduisters@users.noreply.github.com> Date: Thu, 11 Jul 2019 22:58:02 +0200 Subject: [PATCH] Add typings for duckduckgo-images-api (#36803) * Add typings for duckduckgo-images-api * Fix linting issues * Code Review comments solved * Code Review comments solved --- .../duckduckgo-images-api-tests.ts | 3 ++ types/duckduckgo-images-api/index.d.ts | 28 +++++++++++++++++++ types/duckduckgo-images-api/tsconfig.json | 23 +++++++++++++++ types/duckduckgo-images-api/tslint.json | 1 + 4 files changed, 55 insertions(+) create mode 100644 types/duckduckgo-images-api/duckduckgo-images-api-tests.ts create mode 100644 types/duckduckgo-images-api/index.d.ts create mode 100644 types/duckduckgo-images-api/tsconfig.json create mode 100644 types/duckduckgo-images-api/tslint.json diff --git a/types/duckduckgo-images-api/duckduckgo-images-api-tests.ts b/types/duckduckgo-images-api/duckduckgo-images-api-tests.ts new file mode 100644 index 0000000000..2dea0387f3 --- /dev/null +++ b/types/duckduckgo-images-api/duckduckgo-images-api-tests.ts @@ -0,0 +1,3 @@ +import * as duckDuckGoImagesApi from 'duckduckgo-images-api'; +duckDuckGoImagesApi.image_search({query: 'John Duck', moderate: true, retries: 1, iterations: 1 }); +duckDuckGoImagesApi.image_search_generator({query: 'John Duck', moderate: true, retries: 1, iterations: 1 }); diff --git a/types/duckduckgo-images-api/index.d.ts b/types/duckduckgo-images-api/index.d.ts new file mode 100644 index 0000000000..c839396ad0 --- /dev/null +++ b/types/duckduckgo-images-api/index.d.ts @@ -0,0 +1,28 @@ +// Type definitions for duckduckgo-images-api 1.0 +// Project: https://github.com/KshitijMhatre/duckduckgo-images-api +// Definitions by: Bart Duisters +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +export interface DuckDuckGoImage { + image: string; + title: string; + height: number; + thumbnail: string; + width: number; + url: string; + source: string; +} + +export function image_search(params: { + query: string; + moderate?: boolean; + retries?: number; + iterations?: number; +}): Promise; + +export function image_search_generator(params: { + query: string; + moderate?: boolean; + retries?: number; + iterations?: number; +}): Promise; diff --git a/types/duckduckgo-images-api/tsconfig.json b/types/duckduckgo-images-api/tsconfig.json new file mode 100644 index 0000000000..8d8dd767a9 --- /dev/null +++ b/types/duckduckgo-images-api/tsconfig.json @@ -0,0 +1,23 @@ +{ + "compilerOptions": { + "module": "commonjs", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "strictFunctionTypes": true, + "baseUrl": "../", + "typeRoots": [ + "../" + ], + "types": [], + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts", + "duckduckgo-images-api-tests.ts" + ] +} \ No newline at end of file diff --git a/types/duckduckgo-images-api/tslint.json b/types/duckduckgo-images-api/tslint.json new file mode 100644 index 0000000000..3db14f85ea --- /dev/null +++ b/types/duckduckgo-images-api/tslint.json @@ -0,0 +1 @@ +{ "extends": "dtslint/dt.json" }