From 70c27888b38575856c20673cc7f3506432f5ffc6 Mon Sep 17 00:00:00 2001 From: Jiaren Liu Date: Sun, 3 Jun 2018 20:27:32 +0800 Subject: [PATCH 1/2] feat: add declaration file for koa-static-cache --- types/koa-static-cache/index.d.ts | 40 ++++++++++++++++ .../koa-static-cache-tests.ts | 46 +++++++++++++++++++ types/koa-static-cache/tsconfig.json | 23 ++++++++++ types/koa-static-cache/tslint.json | 1 + 4 files changed, 110 insertions(+) create mode 100644 types/koa-static-cache/index.d.ts create mode 100644 types/koa-static-cache/koa-static-cache-tests.ts create mode 100644 types/koa-static-cache/tsconfig.json create mode 100644 types/koa-static-cache/tslint.json diff --git a/types/koa-static-cache/index.d.ts b/types/koa-static-cache/index.d.ts new file mode 100644 index 0000000000..ba5ed2d0e9 --- /dev/null +++ b/types/koa-static-cache/index.d.ts @@ -0,0 +1,40 @@ +// Type definitions for koa-static-cache 5.1 +// Project: https://github.com/koajs/static-cache#readme +// Definitions by: JounQin +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped +// TypeScript Version: 2.3 + +/** + * Static server for koa. + */ + +import { Middleware } from 'koa'; + +declare namespace staticCache { + interface Files { + [path: string]: Options; + } + + interface Options { + dir?: string; + maxAge?: number; + cacheControl?: string; + buffer?: boolean; + gzip?: boolean; + usePrecompiledGzip?: boolean; + alias?: {}; + prefix?: string; + dynamic?: boolean; + filter?: ((path: string) => boolean) | string[]; + preload?: boolean; + files?: Files; + } +} + +declare function staticCache( + dir: string | staticCache.Options, + options?: staticCache.Options | staticCache.Files, + files?: staticCache.Files +): Middleware; + +export = staticCache; diff --git a/types/koa-static-cache/koa-static-cache-tests.ts b/types/koa-static-cache/koa-static-cache-tests.ts new file mode 100644 index 0000000000..0da8d5578f --- /dev/null +++ b/types/koa-static-cache/koa-static-cache-tests.ts @@ -0,0 +1,46 @@ +import * as Koa from 'koa'; +import * as staticCache from 'koa-static-cache'; + +const app = new Koa(); + +app.use(staticCache('.')); + +app.use( + staticCache('.', { + maxAge: 0, + filter: [''] + }) +); + +const files: staticCache.Files = {}; + +app.use( + staticCache( + '.', + { + maxAge: 0, + filter: path => !!path + }, + files + ) +); + +files['/service-worker.js'].maxAge = 0; + +app.use( + staticCache({ + dir: '.', + maxAge: 0, + files + }) +); + +app.use( + staticCache( + { + dir: '.', + maxAge: 0 + }, + files + ) +); diff --git a/types/koa-static-cache/tsconfig.json b/types/koa-static-cache/tsconfig.json new file mode 100644 index 0000000000..61082ed384 --- /dev/null +++ b/types/koa-static-cache/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", + "koa-static-cache-tests.ts" + ] +} diff --git a/types/koa-static-cache/tslint.json b/types/koa-static-cache/tslint.json new file mode 100644 index 0000000000..3db14f85ea --- /dev/null +++ b/types/koa-static-cache/tslint.json @@ -0,0 +1 @@ +{ "extends": "dtslint/dt.json" } From 41a22c965c6b6fb2eab73f40d01afd5613278613 Mon Sep 17 00:00:00 2001 From: JounQin Date: Tue, 5 Jun 2018 09:34:43 +0800 Subject: [PATCH 2/2] Update koa-static-cache-tests.ts --- types/koa-static-cache/koa-static-cache-tests.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/types/koa-static-cache/koa-static-cache-tests.ts b/types/koa-static-cache/koa-static-cache-tests.ts index 0da8d5578f..1906c0bc25 100644 --- a/types/koa-static-cache/koa-static-cache-tests.ts +++ b/types/koa-static-cache/koa-static-cache-tests.ts @@ -1,5 +1,5 @@ -import * as Koa from 'koa'; -import * as staticCache from 'koa-static-cache'; +import Koa = require('koa'); +import staticCache = require('koa-static-cache'); const app = new Koa();