Skip to content

Commit

Permalink
feat(docs): update docs
Browse files Browse the repository at this point in the history
Updates the Wing docs. See details in [workflow run].

[Workflow Run]: https://github.com/winglang/docsite/actions/runs/6762067941

------

*Automatically created via the "update-docs" workflow*

Signed-off-by: monabot <[email protected]>
  • Loading branch information
monadabot committed Nov 5, 2023
1 parent bec8d39 commit 6c6f92c
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,7 @@ new cloud.Bucket(props?: BucketProps);

| **Name** | **Description** |
| --- | --- |
| <code><a href="#@winglang/sdk.cloud.IBucketClient.copy">copy</a></code> | Copy an object to a new location in the bucket. |
| <code><a href="#@winglang/sdk.cloud.IBucketClient.delete">delete</a></code> | Delete an existing object using a key from the bucket. |
| <code><a href="#@winglang/sdk.cloud.IBucketClient.exists">exists</a></code> | Check if an object exists in the bucket. |
| <code><a href="#@winglang/sdk.cloud.IBucketClient.get">get</a></code> | Retrieve an object from the bucket. |
Expand Down Expand Up @@ -314,6 +315,33 @@ Run an inflight whenever a file is updated in the bucket.

---

##### `copy` <a name="copy" id="@winglang/sdk.cloud.IBucketClient.copy"></a>

```wing
inflight copy(srcKey: str, dstKey: str): void
```

Copy an object to a new location in the bucket.

If the destination object
already exists, it will be overwritten. Returns once the copying is finished.

###### `srcKey`<sup>Required</sup> <a name="srcKey" id="@winglang/sdk.cloud.IBucketClient.copy.parameter.srcKey"></a>

- *Type:* str

The key of the source object you wish to copy.

---

###### `dstKey`<sup>Required</sup> <a name="dstKey" id="@winglang/sdk.cloud.IBucketClient.copy.parameter.dstKey"></a>

- *Type:* str

The key of the destination object after copying.

---

##### `delete` <a name="delete" id="@winglang/sdk.cloud.IBucketClient.delete"></a>

```wing
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -127,11 +127,11 @@
"awscdk": { "implemented": false }
},
"copy": {
"sim": { "implemented": false, "issue": 4395 },
"tf-aws": { "implemented": false, "issue": 4396 },
"sim": { "implemented": true },
"tf-aws": { "implemented": true },
"tf-azure": { "implemented": false, "issue": 4397 },
"tf-gcp": { "implemented": false, "issue": 4398 },
"awscdk": { "implemented": false, "issue": 4396 }
"awscdk": { "implemented": true }
},
"list": {
"sim": { "implemented": true },
Expand Down

0 comments on commit 6c6f92c

Please sign in to comment.