From 0f724ed2f86a152750ca70274eb55594c049b937 Mon Sep 17 00:00:00 2001 From: hideokamoto Date: Thu, 7 Nov 2019 11:26:21 +0900 Subject: [PATCH] docs: update --- docs/classes/_index_.cloudfrontupdator.html | 32 +++++++++---------- docs/index.html | 2 +- .../_index_.interfaces.clients.html | 4 +-- .../interfaces/_index_.interfaces.config.html | 6 ++-- .../_index_.interfaces.workers.html | 4 +-- docs/modules/_index_.html | 16 +++++----- docs/modules/_index_.interfaces.html | 18 ++++++++--- 7 files changed, 45 insertions(+), 37 deletions(-) diff --git a/docs/classes/_index_.cloudfrontupdator.html b/docs/classes/_index_.cloudfrontupdator.html index b5c8b15..ab4afee 100644 --- a/docs/classes/_index_.cloudfrontupdator.html +++ b/docs/classes/_index_.cloudfrontupdator.html @@ -127,7 +127,7 @@

constructor

  • Parameters

    @@ -155,7 +155,7 @@

    Protected allowSensitive
    allowSensitiveAction: boolean
    @@ -165,7 +165,7 @@

    Protected cfClient

    cfClient: CloudFront
    @@ -175,7 +175,7 @@

    Protected debugMode

    debugMode: boolean
    @@ -185,7 +185,7 @@

    Protected diff

    diff: any = null
    @@ -195,7 +195,7 @@

    Protected log

    log: Function
    @@ -205,7 +205,7 @@

    Protected taskType

    taskType: TaskType
    @@ -215,7 +215,7 @@

    Protected updator

    @@ -232,7 +232,7 @@

    Protected filter

  • Returns true

    @@ -249,7 +249,7 @@

    getDiff

  • @@ -271,7 +271,7 @@

    Protected isTargetD
  • @@ -301,7 +301,7 @@

    Protected listAllDi
  • @@ -334,7 +334,7 @@

    updateAllDistribution

  • @@ -356,7 +356,7 @@

    Protected updateCloud
    @@ -395,7 +395,7 @@

    updateDistribution

  • @@ -428,7 +428,7 @@

    Protected updateDistribu
  • diff --git a/docs/index.html b/docs/index.html index 0bc14ed..4b9ccad 100644 --- a/docs/index.html +++ b/docs/index.html @@ -122,7 +122,7 @@

    Debug / Dry run

    const client = new CloudFrontUpdator({ // You can define your expected the Distribution config - updator: (id, DistributionConfig) => { + updator: ({id, arn}, DistributionConfig) => { DistributionConfig.HttpVersion = 'http2' return DistributionConfig }, diff --git a/docs/interfaces/_index_.interfaces.clients.html b/docs/interfaces/_index_.interfaces.clients.html index 179fd29..f3bc1d9 100644 --- a/docs/interfaces/_index_.interfaces.clients.html +++ b/docs/interfaces/_index_.interfaces.clients.html @@ -102,7 +102,7 @@

    cfClient

    cfClient: CloudFront
    @@ -112,7 +112,7 @@

    logger

    logger: Function
    diff --git a/docs/interfaces/_index_.interfaces.config.html b/docs/interfaces/_index_.interfaces.config.html index c55c312..05e0ceb 100644 --- a/docs/interfaces/_index_.interfaces.config.html +++ b/docs/interfaces/_index_.interfaces.config.html @@ -103,7 +103,7 @@

    allowSensitiveAction

    allowSensitiveAction: boolean
    @@ -113,7 +113,7 @@

    debugMode

    debugMode: boolean
    @@ -123,7 +123,7 @@

    taskType

    taskType: TaskType
    diff --git a/docs/interfaces/_index_.interfaces.workers.html b/docs/interfaces/_index_.interfaces.workers.html index cbdd135..3afa58d 100644 --- a/docs/interfaces/_index_.interfaces.workers.html +++ b/docs/interfaces/_index_.interfaces.workers.html @@ -102,7 +102,7 @@

    Optional filter

    @@ -112,7 +112,7 @@

    updator

    diff --git a/docs/modules/_index_.html b/docs/modules/_index_.html index 7083729..8b6150d 100644 --- a/docs/modules/_index_.html +++ b/docs/modules/_index_.html @@ -110,7 +110,7 @@

    Const sleep

  • Parameters

    @@ -132,7 +132,7 @@

    Const defaultClients

    defaultClients: object
    @@ -141,7 +141,7 @@

    cfClient

    cfClient: CloudFront = new CloudFront()
    @@ -155,7 +155,7 @@

    logger

  • Parameters

    @@ -175,7 +175,7 @@

    Const defaultConfig

    defaultConfig: object
    @@ -184,7 +184,7 @@

    allowSensitiveAction

    allowSensitiveAction: false = false
    @@ -194,7 +194,7 @@

    debugMode

    debugMode: false = false
    @@ -204,7 +204,7 @@

    taskType

    taskType: "sequential" = "sequential"
    diff --git a/docs/modules/_index_.interfaces.html b/docs/modules/_index_.interfaces.html index 7f0d9e9..b7edb34 100644 --- a/docs/modules/_index_.interfaces.html +++ b/docs/modules/_index_.interfaces.html @@ -100,7 +100,7 @@

    FilterCondition

    FilterCondition: function
    @@ -134,7 +134,7 @@

    TaskType

    TaskType: "parallel" | "sequential"
    @@ -144,7 +144,7 @@

    UpdatorFunction

    UpdatorFunction: function
    @@ -152,14 +152,22 @@

    Type declaration

      • -
      • (distributionId: string, distributionConfig: DistributionConfig): DistributionConfig | null | Promise<DistributionConfig | null>
      • +
      • (dist: object, distributionConfig: DistributionConfig): DistributionConfig | null | Promise<DistributionConfig | null>
      • Parameters

        • -
          distributionId: string
          +
          dist: object
          +
            +
          • +
            arn: string
            +
          • +
          • +
            id: string
            +
          • +
        • distributionConfig: DistributionConfig