@vercel/functions 3.5.0 → 3.6.0

package/docs/interfaces/index.RuntimeCache.md

@@ -1,131 +0,0 @@
-# Interface: RuntimeCache
-
-[index](../modules/index.md).RuntimeCache
-
-Interface representing the runtime cache.
-
-## Table of contents
-
-### Properties
-
-- [delete](index.RuntimeCache.md#delete)
-- [expireTag](index.RuntimeCache.md#expiretag)
-- [get](index.RuntimeCache.md#get)
-- [set](index.RuntimeCache.md#set)
-
-## Properties
-
-### delete
-
-• **delete**: (`key`: `string`) => [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<`void`\>
-
-#### Type declaration
-
-▸ (`key`): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<`void`\>
-
-Deletes a value from the cache.
-
-##### Parameters
-
-| Name  | Type     | Description                     |
-| :---- | :------- | :------------------------------ |
-| `key` | `string` | The key of the value to delete. |
-
-##### Returns
-
-[`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<`void`\>
-
-A promise that resolves when the value is deleted.
-
-#### Defined in
-
-[packages/functions/src/cache/types.ts:11](https://github.com/vercel/vercel/blob/main/packages/functions/src/cache/types.ts#L11)
-
----
-
-### expireTag
-
-• **expireTag**: (`tag`: `string` \| `string`[]) => [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<`void`\>
-
-#### Type declaration
-
-▸ (`tag`): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<`void`\>
-
-Expires cache entries by tag.
-
-##### Parameters
-
-| Name  | Type                   | Description                                     |
-| :---- | :--------------------- | :---------------------------------------------- |
-| `tag` | `string` \| `string`[] | The tag or tags of the cache entries to expire. |
-
-##### Returns
-
-[`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<`void`\>
-
-A promise that resolves when the cache entries expiration request is received.
-
-#### Defined in
-
-[packages/functions/src/cache/types.ts:44](https://github.com/vercel/vercel/blob/main/packages/functions/src/cache/types.ts#L44)
-
----
-
-### get
-
-• **get**: (`key`: `string`) => [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<`unknown`\>
-
-#### Type declaration
-
-▸ (`key`): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<`unknown`\>
-
-Retrieves a value from the cache.
-
-##### Parameters
-
-| Name  | Type     | Description                       |
-| :---- | :------- | :-------------------------------- |
-| `key` | `string` | The key of the value to retrieve. |
-
-##### Returns
-
-[`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<`unknown`\>
-
-A promise that resolves to the value, or null if not found.
-
-#### Defined in
-
-[packages/functions/src/cache/types.ts:19](https://github.com/vercel/vercel/blob/main/packages/functions/src/cache/types.ts#L19)
-
----
-
-### set
-
-• **set**: (`key`: `string`, `value`: `unknown`, `options?`: { `name?`: `string` ; `tags?`: `string`[] ; `ttl?`: `number` }) => [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<`void`\>
-
-#### Type declaration
-
-▸ (`key`, `value`, `options?`): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<`void`\>
-
-Sets a value in the cache.
-
-##### Parameters
-
-| Name            | Type       | Description                                                    |
-| :-------------- | :--------- | :------------------------------------------------------------- |
-| `key`           | `string`   | The key of the value to set.                                   |
-| `value`         | `unknown`  | The value to set.                                              |
-| `options?`      | `Object`   | Optional settings for the cache entry.                         |
-| `options.name?` | `string`   | Optional user-friendly name for the cache entry used for o11y. |
-| `options.tags?` | `string`[] | Optional tags to associate with the cache entry.               |
-| `options.ttl?`  | `number`   | Optional time-to-live for the cache entry, in seconds.         |
-
-##### Returns
-
-[`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<`void`\>
-
-A promise that resolves when the value is set.
-
-#### Defined in
-
-[packages/functions/src/cache/types.ts:32](https://github.com/vercel/vercel/blob/main/packages/functions/src/cache/types.ts#L32)

package/docs/interfaces/oidc.AwsCredentialsProviderInit.md

@@ -1,221 +0,0 @@
-# Interface: AwsCredentialsProviderInit
-
-[oidc](../modules/oidc.md).AwsCredentialsProviderInit
-
-The init object for the `awsCredentialsProvider` function.
-
-## Hierarchy
-
-- [`Omit`](https://www.typescriptlang.org/docs/handbook/utility-types.html#omittype-keys)<`FromWebTokenInit`, `"webIdentityToken"`\>
-
-  ↳ **`AwsCredentialsProviderInit`**
-
-## Table of contents
-
-### Properties
-
-- [clientConfig](oidc.AwsCredentialsProviderInit.md#clientconfig)
-- [clientPlugins](oidc.AwsCredentialsProviderInit.md#clientplugins)
-- [durationSeconds](oidc.AwsCredentialsProviderInit.md#durationseconds)
-- [logger](oidc.AwsCredentialsProviderInit.md#logger)
-- [parentClientConfig](oidc.AwsCredentialsProviderInit.md#parentclientconfig)
-- [policy](oidc.AwsCredentialsProviderInit.md#policy)
-- [policyArns](oidc.AwsCredentialsProviderInit.md#policyarns)
-- [providerId](oidc.AwsCredentialsProviderInit.md#providerid)
-- [roleArn](oidc.AwsCredentialsProviderInit.md#rolearn)
-- [roleAssumerWithWebIdentity](oidc.AwsCredentialsProviderInit.md#roleassumerwithwebidentity)
-- [roleSessionName](oidc.AwsCredentialsProviderInit.md#rolesessionname)
-
-## Properties
-
-### clientConfig
-
-• `Optional` **clientConfig**: `any`
-
-Custom STS client configurations overriding the default ones.
-
-#### Inherited from
-
-Omit.clientConfig
-
-#### Defined in
-
-node*modules/.pnpm/@aws-sdk+credential-provider-web-identity@3.609.0*@aws-sdk+client-sts@3.806.0/node_modules/@aws-sdk/credential-provider-web-identity/dist-types/fromWebToken.d.ts:135
-
----
-
-### clientPlugins
-
-• `Optional` **clientPlugins**: `Pluggable`<`any`, `any`\>[]
-
-Custom STS client middleware plugin to modify the client default behavior.
-
-#### Inherited from
-
-Omit.clientPlugins
-
-#### Defined in
-
-node*modules/.pnpm/@aws-sdk+credential-provider-web-identity@3.609.0*@aws-sdk+client-sts@3.806.0/node_modules/@aws-sdk/credential-provider-web-identity/dist-types/fromWebToken.d.ts:139
-
----
-
-### durationSeconds
-
-• **durationSeconds**: `undefined` \| `number`
-
-The duration, in seconds, of the role session. Defaults to 3600 seconds.
-
-#### Inherited from
-
-Omit.durationSeconds
-
----
-
-### logger
-
-• `Optional` **logger**: `Logger`
-
-This logger is only used to provide information
-on what credential providers were used during resolution.
-
-It does not log credentials.
-
-#### Inherited from
-
-Omit.logger
-
-#### Defined in
-
-node_modules/.pnpm/@aws-sdk+types@3.609.0/node_modules/@aws-sdk/types/dist-types/credentials.d.ts:31
-
----
-
-### parentClientConfig
-
-• `Optional` **parentClientConfig**: `Object`
-
-Present if the credential provider was created by calling
-the defaultCredentialProvider in a client's middleware, having
-access to the client's config.
-
-The region of that parent or outer client is important because
-an inner client used by the credential provider may need
-to match its default partition or region with that of
-the outer client.
-
-**`Deprecated`**
-
-- not truly deprecated, marked as a warning to not use this.
-
-#### Index signature
-
-▪ [key: `string`]: `unknown`
-
-#### Type declaration
-
-| Name      | Type                              |
-| :-------- | :-------------------------------- |
-| `region?` | `string` \| `Provider`<`string`\> |
-
-#### Inherited from
-
-Omit.parentClientConfig
-
-#### Defined in
-
-node_modules/.pnpm/@aws-sdk+types@3.609.0/node_modules/@aws-sdk/types/dist-types/credentials.d.ts:45
-
----
-
-### policy
-
-• **policy**: `undefined` \| `string`
-
-An IAM policy in JSON format that you want to use as an inline session policy.
-
-#### Inherited from
-
-Omit.policy
-
----
-
-### policyArns
-
-• **policyArns**: `undefined` \| { `arn?`: `string` }[]
-
-ARNs of the IAM managed policies that you want to use as managed session policies.
-
-#### Inherited from
-
-Omit.policyArns
-
----
-
-### providerId
-
-• **providerId**: `undefined` \| `string`
-
-The fully qualified host component of the domain name of the identity provider.
-
-#### Inherited from
-
-Omit.providerId
-
----
-
-### roleArn
-
-• **roleArn**: `string`
-
-ARN of the role that the caller is assuming.
-
-#### Inherited from
-
-Omit.roleArn
-
----
-
-### roleAssumerWithWebIdentity
-
-• `Optional` **roleAssumerWithWebIdentity**: (`params`: `AssumeRoleWithWebIdentityParams`) => [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<`AwsCredentialIdentity`\>
-
-#### Type declaration
-
-▸ (`params`): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<`AwsCredentialIdentity`\>
-
-A function that assumes a role with web identity and returns a promise fulfilled with credentials for the assumed role.
-
-##### Parameters
-
-| Name     | Type                              |
-| :------- | :-------------------------------- |
-| `params` | `AssumeRoleWithWebIdentityParams` |
-
-##### Returns
-
-[`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<`AwsCredentialIdentity`\>
-
-#### Inherited from
-
-Omit.roleAssumerWithWebIdentity
-
-#### Defined in
-
-node*modules/.pnpm/@aws-sdk+credential-provider-web-identity@3.609.0*@aws-sdk+client-sts@3.806.0/node_modules/@aws-sdk/credential-provider-web-identity/dist-types/fromWebToken.d.ts:130
-
----
-
-### roleSessionName
-
-• `Optional` **roleSessionName**: `string`
-
-An identifier for the assumed role session.
-
-#### Inherited from
-
-Omit.roleSessionName
-
-#### Defined in
-
-node*modules/.pnpm/@aws-sdk+credential-provider-web-identity@3.609.0*@aws-sdk+client-sts@3.806.0/node_modules/@aws-sdk/credential-provider-web-identity/dist-types/fromWebToken.d.ts:123