satay下載 - satay源代碼下載

satay

其他類別

1.0.0

下載

衛星

將靜態站點上傳到AWS S3的實用程序。

用法

使用CLI

全球安裝satay ：
```
$ npm install -g satay
```

創建一個配置文件：

satay.config.js

 module . exports = {
  bucket : 'jameslnewell.me' ,

  groups : [
    {
      source : './static' ,
      include : / .html$ /
    } ,

    //cache finger-printed assets for up to 1 year
    {
      source : './static' ,
      exclude : / .html$ / ,
      params : {
        CacheControl : `max-age= ${ 60 * 60 * 24 * 365.25 } , public`
      }
    }
  ]
} ;

配置您的AWS憑據
運行satay
```
$ satay
```

使用API

本地安裝satay ：
```
$ npm install --save-dev satay
```

創建一個腳本文件：

upload.js

 import satay from 'satay' ;

satay (
  'jameslnewell.me' ,
  [
    {
      source : './static' ,
      include : / .html$ /
    } ,

    //cache finger-printed assets for up to 1 year
    {
      source : './static' ,
      exclude : / .html$ / ,
      params : {
        CacheControl : `max-age= ${ 60 * 60 * 24 * 365.25 } , public`
      }
    }
  ] ,
  {
    shouldUploadUnmodifiedObjects : true
  }
) ;

配置您的AWS憑據
運行upload.js
```
$ node upload.js
```

CLI

$ satay --config=satay.config.js

標誌：

--config可選。配置文件名。默認為當前工作目錄中的satay.config.js 。

配置

特性：

bucket -可選。 string 。水桶的名稱。
groups -需要。一array文件分組。
- source -可選。 string 。將要搜索的目錄。默認為process.cwd() 。
- include -可選。 RegExp或function 。正則表達式或函數要過濾哪些文件。
- exclude -可選。 RegExp或function 。正則表達式或函數，用於過濾哪些文件被排除。
- prefix -可選。 string 。將備用到對象鍵的前綴。默認為"" 。
- params -可選。一個object 。傳遞給S3.putObject()其他參數。默認為{ContentType: mime.lookup(filename), ACL: 'public-read'} 。
policy -可選。一個object 。 AWS政策。默認為所有文件的公共讀取訪問。
website -可選。一個object 。 AWS網站配置。將index.html用作默認IndexDocument和404.html作為默認ErrorDocument 。
shouldCreateBucket -可選。 boolean 。如果不存在，是否應該創建水桶。
shouldConfigureBucket可選。 boolean 。如果不存在，是否應將其配置為公共網站。
shouldUploadUnmodifiedObjects可選。 boolean 。即使磁盤上未修改的文件與存儲庫中的文件相同，也應上傳。
shouldDeleteDeletedObjects -可選。 boolean 。從磁盤上刪除文件時，是否應刪除存儲桶中的對象。

API

 satay ( bucket : String , groups : Array < Group > , options : Object ) : Promise

參數：

bucket -必需。 string 。水桶的名稱。
groups -需要。一array文件分組。
- source -可選。 string 。將要搜索的目錄。默認為process.cwd() 。
- include -可選。 RegExp或function 。正則表達式或函數要過濾哪些文件。
- exclude -可選。 RegExp或function 。正則表達式或函數，用於過濾哪些文件被排除。
- prefix -可選。 string 。將備用到對象鍵的前綴。默認為"" 。
- params -可選。一個object 。傳遞給S3.putObject()其他參數。默認為{ContentType: mime.lookup(filename), ACL: 'public-read'} 。
options -可選。一個object 。其他選項。
- policy -可選。一個object 。 AWS政策。默認為所有文件的公共讀取訪問。
- website -可選。一個object 。 AWS網站配置。將index.html用作默認IndexDocument和404.html作為默認ErrorDocument 。
- shouldCreateBucket -可選。 boolean 。如果不存在，是否應該創建水桶。
- shouldConfigureBucket可選。 boolean 。如果不存在，是否應將其配置為公共網站。
- shouldUploadUnmodifiedObjects可選。 boolean 。即使磁盤上未修改的文件與存儲庫中的文件相同，也應上傳。
- shouldDeleteDeletedObjects -可選。 boolean 。從磁盤上刪除文件時，是否應刪除存儲桶中的對象。