Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Options

Hierarchy

  • Options

Index

Properties

accessKeyId

accessKeyId: string

access secret you create

accessKeySecret

accessKeySecret: string

access secret you create

Optional bucket

bucket: string

the default bucket you want to access If you don't have any bucket, please use putBucket() create one first.

Optional cname

cname: boolean

use custom domain name

Optional endpoint

endpoint: string

oss region domain. It takes priority over region.

Optional internal

internal: boolean

access OSS with aliyun internal network or not, default is false. If your servers are running on aliyun too, you can set true to save lot of money.

Optional refreshSTSTokenInterval

refreshSTSTokenInterval: number

use time (ms) of refresh STSToken interval it should be less than sts info expire interval, default is 300000ms(5min) when sts info expires.

Optional region

region: string

the bucket data region location, please see Data Regions, default is oss-cn-hangzhou.

Optional secure

secure: boolean

instruct OSS client to use HTTPS (secure: true) or HTTP (secure: false) protocol.

Optional stsToken

stsToken: string

used by temporary authorization

Optional timeout

timeout: string | number

instance level timeout for all operations, default is 60s

Methods

Optional refreshSTSToken

  • refreshSTSToken(): Promise<{ accessKeyId: string; accessKeySecret: string; stsToken: string }>
  • used by auto set stsToken、accessKeyId、accessKeySecret when sts info expires. return value must be object contains stsToken、accessKeyId、accessKeySecret

    Returns Promise<{ accessKeyId: string; accessKeySecret: string; stsToken: string }>

Generated using TypeDoc