From ad096f1d79bffdaf60b469fee8da04960d930d7b Mon Sep 17 00:00:00 2001 From: marinewater Date: Sun, 28 Feb 2016 01:59:46 +0100 Subject: [PATCH] add fromnow typings --- fromnow/fromnow-tests.ts | 25 +++++++++++++++++++++++++ fromnow/fromnow.d.ts | 28 ++++++++++++++++++++++++++++ 2 files changed, 53 insertions(+) create mode 100644 fromnow/fromnow-tests.ts create mode 100644 fromnow/fromnow.d.ts diff --git a/fromnow/fromnow-tests.ts b/fromnow/fromnow-tests.ts new file mode 100644 index 000000000..b95a23640 --- /dev/null +++ b/fromnow/fromnow-tests.ts @@ -0,0 +1,25 @@ +/// + +import fromnow = require( 'fromnow' ); + +function dateOnly() { + fromnow( '2015-12-31' ); +} + +function maxChunks() { + fromnow( '2015-12-31', { + maxChunks: 12 + }); +} + +function useAgo() { + fromnow( '2015-12-31', { + useAgo: true + }); +} + +function useAnd() { + fromnow( '2015-12-31', { + useAnd: true + }); +} \ No newline at end of file diff --git a/fromnow/fromnow.d.ts b/fromnow/fromnow.d.ts new file mode 100644 index 000000000..afb5235fa --- /dev/null +++ b/fromnow/fromnow.d.ts @@ -0,0 +1,28 @@ +// Type definitions for fromnow v2.0.0 +// Project: https://github.com/lukeed/fromNow +// Definitions by: Martin Bukovics +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +declare module FromNow { + interface FromNowOpts { + maxChunks?: number, + useAgo?: boolean, + useAnd?: boolean + } + export interface FromNowStatic { + /** + * Get readable time differences from now vs past or future dates. + * @param {string} date + * @param {object} [opts] + * @param {number} [opts.maxChucks=10] + * @param {boolean} [opts.useAgo=false] + * @param {boolean} [opts.useAnd=false] + */ + (date: string, opts?: FromNowOpts): string + } +} + +declare module 'fromnow' { + var FromNow: FromNow.FromNowStatic; + export = FromNow; +} \ No newline at end of file