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 。从磁盘上删除文件时，是否应删除存储桶中的对象。