diff --git a/packages/types/package.json b/packages/types/package.json index 78b5dce..3992c86 100644 --- a/packages/types/package.json +++ b/packages/types/package.json @@ -1,6 +1,6 @@ { "name": "@tailor-platform/function-types", - "version": "0.2.0", + "version": "0.3.0", "description": "TypeScript types for Tailor Platform Function service", "repository": { "type": "git", diff --git a/packages/types/tailor.d.ts b/packages/types/tailor.d.ts index 4b50e13..010e117 100644 --- a/packages/types/tailor.d.ts +++ b/packages/types/tailor.d.ts @@ -31,8 +31,24 @@ declare const tailordb: { }; declare namespace tailor.secretmanager { - // getSecrets returns multiple secret objects(key=name, value=secret) at once according to vault, names - function getSecrets(vault: string, names: string[]): Promise> - // getSecret returns a secret according to vault, name - function getSecret(vault: string, name: string): Promise -} + /** + * getSecrets returns multiple secret objects (key = name, value = secret) + * at once according to vault and secret names. + * + * If a secret does not exist, it will not be included in the result. + */ + function getSecrets( + vault: string, + names: T + ): Promise>>; + + /** + * getSecret returns a secret according to vault and name. + * + * If the secret does not exist, undefined is returned. + */ + function getSecret( + vault: string, + name: string + ): Promise; +} \ No newline at end of file