From 9f5deb7171daf738d38708ea20d2483b2b8aed8d Mon Sep 17 00:00:00 2001 From: Wolfgang Faust Date: Tue, 16 May 2017 23:35:04 -0400 Subject: [PATCH] Add type definitions for url-assembler library. --- types/url-assembler/index.d.ts | 28 ++++++++++++++++++++++ types/url-assembler/tsconfig.json | 22 +++++++++++++++++ types/url-assembler/tslint.json | 1 + types/url-assembler/url-assembler-tests.ts | 7 ++++++ 4 files changed, 58 insertions(+) create mode 100644 types/url-assembler/index.d.ts create mode 100644 types/url-assembler/tsconfig.json create mode 100644 types/url-assembler/tslint.json create mode 100644 types/url-assembler/url-assembler-tests.ts diff --git a/types/url-assembler/index.d.ts b/types/url-assembler/index.d.ts new file mode 100644 index 0000000000..3f33bf921a --- /dev/null +++ b/types/url-assembler/index.d.ts @@ -0,0 +1,28 @@ +// Type definitions for url-assembler 1.2 +// Project: https://github.com/Floby/node-url-assembler +// Definitions by: Wolfgang Faust +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +interface UrlAssembler { + template(template: string): UrlAssembler; + prefix(subPath: string): UrlAssembler; + segment(subPathTemplate: string): UrlAssembler; + param(key: string, value: string, strict: boolean): UrlAssembler; + param(params: {[s: string]: any}, strict: boolean): UrlAssembler; + query(key: string, value: any): UrlAssembler; + query(params: {[s: string]: any}): UrlAssembler; + toString(): string; + valueOf(): string; + toJSON(): string; +} + +interface UrlAssemblerConstructor { + (baseUrl?: string): UrlAssembler; + (urlAssembler: UrlAssembler): UrlAssembler; + new (baseUrl?: string): UrlAssembler; + new (urlAssembler: UrlAssembler): UrlAssembler; +} + +declare const UrlAssembler: UrlAssemblerConstructor; + +export = UrlAssembler; diff --git a/types/url-assembler/tsconfig.json b/types/url-assembler/tsconfig.json new file mode 100644 index 0000000000..ae213e8bc0 --- /dev/null +++ b/types/url-assembler/tsconfig.json @@ -0,0 +1,22 @@ +{ + "compilerOptions": { + "module": "commonjs", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "baseUrl": "../", + "typeRoots": [ + "../" + ], + "types": [], + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts", + "url-assembler-tests.ts" + ] +} diff --git a/types/url-assembler/tslint.json b/types/url-assembler/tslint.json new file mode 100644 index 0000000000..4e88071852 --- /dev/null +++ b/types/url-assembler/tslint.json @@ -0,0 +1 @@ +{"extends": "dtslint/dt.json"} diff --git a/types/url-assembler/url-assembler-tests.ts b/types/url-assembler/url-assembler-tests.ts new file mode 100644 index 0000000000..997c619218 --- /dev/null +++ b/types/url-assembler/url-assembler-tests.ts @@ -0,0 +1,7 @@ +import UrlAssembler = require('url-assembler'); +UrlAssembler('http://goggle.com').segment('string'); +const f = new UrlAssembler('https://foo/bar/'); + +function printUrl(u: UrlAssembler) { + return u.toJSON(); +}