UNPKG

1.23 kBTypeScriptView Raw
1export declare class Signer {
2 /**
3 * Sign a HTTP request, add 'Authorization' header to request param
4 * @method sign
5 * @memberof Signer
6 * @static
7 *
8 * @param {object} request - HTTP request object
9 <pre>
10 request: {
11 method: GET | POST | PUT ...
12 url: ...,
13 headers: {
14 header1: ...
15 },
16 data: data
17 }
18 </pre>
19 * @param {object} access_info - AWS access credential info
20 <pre>
21 access_info: {
22 access_key: ...,
23 secret_key: ...,
24 session_token: ...
25 }
26 </pre>
27 * @param {object} [service_info] - AWS service type and region, optional,
28 * if not provided then parse out from url
29 <pre>
30 service_info: {
31 service: ...,
32 region: ...
33 }
34 </pre>
35 *
36 * @returns {object} Signed HTTP request
37 */
38 static sign(request: any, access_info: any, service_info?: any): any;
39 static signUrl(urlToSign: string, accessInfo: any, serviceInfo?: any, expiration?: number): string;
40 static signUrl(request: any, accessInfo: any, serviceInfo?: any, expiration?: number): string;
41}
42/**
43 * @deprecated use per-function import
44 */
45export default Signer;