这是indexloc提供的服务，不要输入任何密码
Skip to content

[@types/aws-cloudfront-function] overridecf.kvs for optional argument (#73959) #74003

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[@types/aws-cloudfront-function] overridecf.kvs for optional argument (#73959) #74003

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions types/aws-cloudfront-function/aws-cloudfront-function-tests.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,10 @@ function handler2(event: AWSCloudFrontFunction.Event): AWSCloudFrontFunction.Req

import cf from "cloudfront";

// $ExpectType KVStore
cf.kvs();

// $ExpectType KVStore
const kvsHandle = cf.kvs("example-kvs-id");

async function handler3(
Expand Down
18 changes: 15 additions & 3 deletions types/aws-cloudfront-function/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,9 +62,21 @@ declare namespace AWSCloudFrontFunction {

declare module "cloudfront" {
/**
* Retrieves a reference to a CloudFront Key-Value Store (KVS) by its ID.
* @param kvsId The identifier of the KVS to use.
* @see https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/functions-custom-methods.html
* Retrieves the current Function's associated KeyValueStore. See the
* {@link https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/functions-custom-methods.html | CloudFront Developer Guide}.
* @returns An instance of the associated KeyValueStore.
* @throws If no KeyValueStore is associated with the Function.
*/
function kvs(): KVStore;

/**
* Retrieves a reference to the current Function's associated KeyValueStore by its ID. Though not documented
* in the {@link https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/functions-custom-methods.html | CloudFront Developer Guide},
* this overload has been proven to work in practice and is shown in the
* {@link https://aws.amazon.com/blogs/aws/introducing-amazon-cloudfront-keyvaluestore-a-low-latency-datastore-for-cloudfront-functions/ | AWS News Blog announcement}.
* @param kvsId The identifier of an associated KeyValueStore.
* @returns An instance of the KeyValueStore.
* @throws If KeyValueStore does not exist or is not associated with the Function.
*/
function kvs(kvsId: string): KVStore;

Expand Down