From cc626d87f5854f9b7935c0821e549d818b917f59 Mon Sep 17 00:00:00 2001 From: Florian Eitel Date: Fri, 23 Oct 2020 18:25:41 +0200 Subject: [PATCH] Fix typings for credentials provider chain `Credentials[]|providers[]` means either an array with `Credentials` or an array with `providers`. But in reality it's a array with both. --- .changes/next-release/bugfix-Types-7306bc23.json | 5 +++++ lib/credentials/credential_provider_chain.d.ts | 4 ++-- 2 files changed, 7 insertions(+), 2 deletions(-) create mode 100644 .changes/next-release/bugfix-Types-7306bc23.json diff --git a/.changes/next-release/bugfix-Types-7306bc23.json b/.changes/next-release/bugfix-Types-7306bc23.json new file mode 100644 index 0000000000..00ad2add11 --- /dev/null +++ b/.changes/next-release/bugfix-Types-7306bc23.json @@ -0,0 +1,5 @@ +{ + "type": "bugfix", + "category": "Types", + "description": "Update types for credential provider chain" +} \ No newline at end of file diff --git a/lib/credentials/credential_provider_chain.d.ts b/lib/credentials/credential_provider_chain.d.ts index 2c102b298e..41cc00eca2 100644 --- a/lib/credentials/credential_provider_chain.d.ts +++ b/lib/credentials/credential_provider_chain.d.ts @@ -8,7 +8,7 @@ export class CredentialProviderChain { /** * Resolves the provider chain by searching for the first set of credentials in providers. */ - resolve(callback:(err: AWSError, credentials: Credentials) => void): CredentialProviderChain; + resolve(callback:(err: AWSError|null, credentials?: Credentials) => void): CredentialProviderChain; /** * Return a Promise on resolve() function */ @@ -16,7 +16,7 @@ export class CredentialProviderChain { /** * Returns a list of credentials objects or functions that return credentials objects. If the provider is a function, the function will be executed lazily when the provider needs to be checked for valid credentials. By default, this object will be set to the defaultProviders. */ - providers: Credentials[]|provider[]; + providers: Array; static defaultProviders: provider[] }