Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 0 additions & 24 deletions .changeset/expose-ts-on-chat-streamer.md

This file was deleted.

5 changes: 0 additions & 5 deletions .changeset/stale-dolls-shave.md

This file was deleted.

29 changes: 27 additions & 2 deletions docs/english/reference/web-api/classes/ChatStreamer.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,31 @@ await streamer.stop();
- [https://docs.slack.dev/reference/methods/chat.appendStream](https://docs.slack.dev/reference/methods/chat.appendStream)
- [https://docs.slack.dev/reference/methods/chat.stopStream](https://docs.slack.dev/reference/methods/chat.stopStream)

## Accessors

### ts

#### Get Signature

```ts
get ts(): string | undefined;
```

Defined in: [packages/web-api/src/chat-stream.ts:62](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/chat-stream.ts#L62)

##### Description

The message timestamp of the stream. Returns `undefined` until the first flush
(when `chat.startStream` is called).

##### See

[https://docs.slack.dev/reference/methods/chat.update](https://docs.slack.dev/reference/methods/chat.update)

##### Returns

`string` \| `undefined`

## Methods

### append()
Expand All @@ -81,7 +106,7 @@ append(args): Promise<
| null>;
```

Defined in: [packages/web-api/src/chat-stream.ts:77](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/chat-stream.ts#L77)
Defined in: [packages/web-api/src/chat-stream.ts:86](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/chat-stream.ts#L86)

Append to the stream.

Expand Down Expand Up @@ -132,7 +157,7 @@ await streamer.stop();
stop(args?): Promise<ChatStopStreamResponse>;
```

Defined in: [packages/web-api/src/chat-stream.ts:123](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/chat-stream.ts#L123)
Defined in: [packages/web-api/src/chat-stream.ts:132](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/chat-stream.ts#L132)

Stop the stream and finalize the message.

Expand Down
2 changes: 1 addition & 1 deletion docs/english/reference/web-api/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# @slack/web-api v7.16.0
# @slack/web-api v7.17.0

## Enumerations

Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 6 additions & 0 deletions packages/cli-hooks/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# @slack/cli-hooks

## 1.3.3

### Patch Changes

- f430ae8: fix: use correct bolt-js release notes tag format

## 1.3.2

### Patch Changes
Expand Down
2 changes: 1 addition & 1 deletion packages/cli-hooks/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@slack/cli-hooks",
"version": "1.3.2",
"version": "1.3.3",
"description": "Node implementation of the contract between the Slack CLI and Bolt for JavaScript",
"author": "Slack Technologies, LLC",
"license": "MIT",
Expand Down
25 changes: 25 additions & 0 deletions packages/web-api/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,30 @@
# @slack/web-api

## 7.17.0

### Minor Changes

- 2085900: feat: expose public read-only `ts` getter on `ChatStreamer` for fallback to [`chat.update`](https://docs.slack.dev/reference/methods/chat.update) when a stream expires server-side

```js
import { WebClient } from "@slack/web-api";

const client = new WebClient(process.env.SLACK_BOT_TOKEN);

const streamer = client.chatStream({
channel: "C0123456789",
thread_ts: "1700000001.123456",
recipient_team_id: "T0123456789",
recipient_user_id: "U0123456789",
});

await streamer.append({ markdown_text: "hello!" });
// streamer.ts is now set after the first flush
console.log(streamer.ts);

await streamer.stop();
```

## 7.16.0

### Minor Changes
Expand Down
2 changes: 1 addition & 1 deletion packages/web-api/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@slack/web-api",
"version": "7.16.0",
"version": "7.17.0",
"description": "Official library for using the Slack Platform's Web API",
"author": "Slack Technologies, LLC",
"license": "MIT",
Expand Down