JSPM

@aws-sdk/s3-request-presigner

1.0.0-beta.4
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 4899008
  • Score
    100M100P100Q344051F
  • License Apache-2.0

Package Exports

  • @aws-sdk/s3-request-presigner

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@aws-sdk/s3-request-presigner) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@aws-sdk/s3-request-presigner

NPM version NPM downloads

This package provides a presigner based on signature V4 that will attempt to generate signed url for S3.

JavaScript Example:

const S3Presigner = require("@aws-sdk/s3-request-presigner").S3RequestPresigner;
const browserSha256 = require("@aws-crypto/sha256-browser").Sha256;
const nodeSha256 = require("@aws-sdk/hash-node").Hash;
const signer = new S3Presigner({
  region: regionProvider,
  credentials: credentialsProvider,
  sha256: nodeSha256 //if the signer is used in browser, use `browserSha256` then
});
const url = await signer.presign(request);

Typescript Example:

import { S3RequestPresigner } from "@aws-sdk/s3-request-presigner";
import { Sha256 as browserSha256 } from "@aws-crypto/sha256-browser";
import { Hash as nodeSha256 } from "@aws-sdk/hash-node";
const signer = new S3RequestPresigner({
  region: regionProvider,
  credentials: credentialsProvider,
  sha256: nodeSha256 //if the signer is used in browser, use `browserSha256` then
});
const url = await signer.presign(request);

To avoid redundant construction parameters when instantiate the s3 presigner, you can simply spread the configurations of an existing s3 clients and supply to the presigner's constructor.

//s3 is instantiated from S3Client from @aws-sdk/client-s3-* packages
const signer = new S3RequestPresigner({
  ...s3.config
});