From 98c1778503a87f823ead8f9828cc57b65a42d8ea Mon Sep 17 00:00:00 2001 From: Nick Zelei Date: Wed, 16 Aug 2017 12:02:51 -0500 Subject: [PATCH] add types for 'parse-link-header' module (#18994) * add types for 'parse-link-header' module * updated return type has possibility of returning null if input is falsy. * Update parse-link-header-tests.ts updated test to include null type. --- types/parse-link-header/index.d.ts | 19 ++++++++++++++++ .../parse-link-header-tests.ts | 8 +++++++ types/parse-link-header/tsconfig.json | 22 +++++++++++++++++++ types/parse-link-header/tslint.json | 1 + 4 files changed, 50 insertions(+) create mode 100644 types/parse-link-header/index.d.ts create mode 100644 types/parse-link-header/parse-link-header-tests.ts create mode 100644 types/parse-link-header/tsconfig.json create mode 100644 types/parse-link-header/tslint.json diff --git a/types/parse-link-header/index.d.ts b/types/parse-link-header/index.d.ts new file mode 100644 index 0000000000..57837d8a86 --- /dev/null +++ b/types/parse-link-header/index.d.ts @@ -0,0 +1,19 @@ +// Type definitions for parse-link-header 1.0 +// Project: https://github.com/thlorenz/parse-link-header +// Definitions by: Nick Zelei +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +declare namespace parseLinkHeader { + interface Link { + url: string; + rel: string; + [queryParam: string]: string; + } + + interface Links { + [rel: string]: Link; + } +} + +declare function parseLinkHeader(linkHeader: string): parseLinkHeader.Links | null; +export = parseLinkHeader; diff --git a/types/parse-link-header/parse-link-header-tests.ts b/types/parse-link-header/parse-link-header-tests.ts new file mode 100644 index 0000000000..01a4de8a8f --- /dev/null +++ b/types/parse-link-header/parse-link-header-tests.ts @@ -0,0 +1,8 @@ +import * as parse from "parse-link-header"; + +const linkHeader = + '; rel="next", ' + + '; rel="prev"; pet="cat", ' + + '; rel="last"'; + +const links: parse.Links | null = parse(linkHeader); diff --git a/types/parse-link-header/tsconfig.json b/types/parse-link-header/tsconfig.json new file mode 100644 index 0000000000..02e284e352 --- /dev/null +++ b/types/parse-link-header/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", + "parse-link-header-tests.ts" + ] +} diff --git a/types/parse-link-header/tslint.json b/types/parse-link-header/tslint.json new file mode 100644 index 0000000000..3db14f85ea --- /dev/null +++ b/types/parse-link-header/tslint.json @@ -0,0 +1 @@ +{ "extends": "dtslint/dt.json" }