From a569f2828e363627f4e3dce5344e2be4659807d2 Mon Sep 17 00:00:00 2001 From: Ian Dela Cruz Date: Tue, 1 Sep 2020 06:39:25 +0800 Subject: [PATCH] trying out type definition --- package.json | 1 + types/index.d.ts | 13 +++++++++++++ 2 files changed, 14 insertions(+) create mode 100644 types/index.d.ts diff --git a/package.json b/package.json index 819c2e7..1898e9b 100644 --- a/package.json +++ b/package.json @@ -3,6 +3,7 @@ "version": "0.8.4", "description": "Lightweight DynamoDB ODM", "main": "dist/ddb.js", + "types": "types/index.d.ts", "scripts": { "bundle": "webpack", "clean": "rm -fR dist", diff --git a/types/index.d.ts b/types/index.d.ts new file mode 100644 index 0000000..eeae731 --- /dev/null +++ b/types/index.d.ts @@ -0,0 +1,13 @@ +declare namespace DDB { + class Document { + toObject(): Object; + toJSON(): String; + pKey(): Object; + sKey(): Object; + } + class Schema { + constructor(fields: Object, pKey: Object, sKey: Object): void; + } + declare function db(op: String, params: Object): Promise; + declare function model(name: String, schema: Schema): Document; +}