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..1906c0bc25 --- /dev/null +++ b/types/koa-static-cache/koa-static-cache-tests.ts @@ -0,0 +1,46 @@ +import Koa = require('koa'); +import staticCache = require('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" }