Streams

(streams)

Overview

Manage streams

Available Operations

listStreams - List streams.
createStream - Create a stream.
getStreamConfig - Get stream configuration.
createOrReconfigureStream - Create or reconfigure a stream.
deleteStream - Delete a stream.
reconfigureStream - Reconfigure a stream.

listStreams

List streams.

Example Usage

import { S2 } from "@s2-dev/streamstore";

const s2 = new S2({
  accessToken: process.env["S2_ACCESS_TOKEN"] ?? "",
});

async function run() {
  const result = await s2.streams.listStreams({
    s2Basin: "<value>",
  });

  for await (const page of result) {
    console.log(page);
  }
}

run();

Standalone function

The standalone function version of this method:

import { S2Core } from "@s2-dev/streamstore/core.js";
import { streamsListStreams } from "@s2-dev/streamstore/funcs/streamsListStreams.js";

// Use `S2Core` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const s2 = new S2Core({
  accessToken: process.env["S2_ACCESS_TOKEN"] ?? "",
});

async function run() {
  const res = await streamsListStreams(s2, {
    s2Basin: "<value>",
  });
  if (res.ok) {
    const { value: result } = res;
    for await (const page of result) {
    console.log(page);
  }
  } else {
    console.log("streamsListStreams failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description
`request`	operations.ListStreamsRequest	✔️	The request object to use for the request.
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.
`options.serverURL`	string	➖	An optional server URL to use.

Response

Promise<operations.ListStreamsResponse>

Errors

Error Type	Status Code	Content Type
errors.ErrorResponse	400, 403, 404	application/json
errors.APIError	4XX, 5XX	/

createStream

Create a stream.

Example Usage

import { S2 } from "@s2-dev/streamstore";

const s2 = new S2({
  accessToken: process.env["S2_ACCESS_TOKEN"] ?? "",
});

async function run() {
  const result = await s2.streams.createStream({
    s2Basin: "<value>",
    createStreamRequest: {
      stream: "<value>",
    },
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { S2Core } from "@s2-dev/streamstore/core.js";
import { streamsCreateStream } from "@s2-dev/streamstore/funcs/streamsCreateStream.js";

// Use `S2Core` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const s2 = new S2Core({
  accessToken: process.env["S2_ACCESS_TOKEN"] ?? "",
});

async function run() {
  const res = await streamsCreateStream(s2, {
    s2Basin: "<value>",
    createStreamRequest: {
      stream: "<value>",
    },
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("streamsCreateStream failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description
`request`	operations.CreateStreamRequest	✔️	The request object to use for the request.
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.
`options.serverURL`	string	➖	An optional server URL to use.

Response

Promise<components.StreamInfo>

Errors

Error Type	Status Code	Content Type
errors.ErrorResponse	400, 403, 404, 409	application/json
errors.APIError	4XX, 5XX	/

getStreamConfig

Get stream configuration.

Example Usage

import { S2 } from "@s2-dev/streamstore";

const s2 = new S2({
  accessToken: process.env["S2_ACCESS_TOKEN"] ?? "",
});

async function run() {
  const result = await s2.streams.getStreamConfig({
    stream: "<value>",
    s2Basin: "<value>",
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { S2Core } from "@s2-dev/streamstore/core.js";
import { streamsGetStreamConfig } from "@s2-dev/streamstore/funcs/streamsGetStreamConfig.js";

// Use `S2Core` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const s2 = new S2Core({
  accessToken: process.env["S2_ACCESS_TOKEN"] ?? "",
});

async function run() {
  const res = await streamsGetStreamConfig(s2, {
    stream: "<value>",
    s2Basin: "<value>",
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("streamsGetStreamConfig failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description
`request`	operations.GetStreamConfigRequest	✔️	The request object to use for the request.
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.
`options.serverURL`	string	➖	An optional server URL to use.

Response

Promise<components.StreamConfig>

Errors

Error Type	Status Code	Content Type
errors.ErrorResponse	400, 403, 404, 409	application/json
errors.APIError	4XX, 5XX	/

createOrReconfigureStream

Create or reconfigure a stream.

Example Usage

import { S2 } from "@s2-dev/streamstore";

const s2 = new S2({
  accessToken: process.env["S2_ACCESS_TOKEN"] ?? "",
});

async function run() {
  const result = await s2.streams.createOrReconfigureStream({
    stream: "<value>",
    s2Basin: "<value>",
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { S2Core } from "@s2-dev/streamstore/core.js";
import { streamsCreateOrReconfigureStream } from "@s2-dev/streamstore/funcs/streamsCreateOrReconfigureStream.js";

// Use `S2Core` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const s2 = new S2Core({
  accessToken: process.env["S2_ACCESS_TOKEN"] ?? "",
});

async function run() {
  const res = await streamsCreateOrReconfigureStream(s2, {
    stream: "<value>",
    s2Basin: "<value>",
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("streamsCreateOrReconfigureStream failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description
`request`	operations.CreateOrReconfigureStreamRequest	✔️	The request object to use for the request.
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.
`options.serverURL`	string	➖	An optional server URL to use.

Response

Promise<components.StreamInfo>

Errors

Error Type	Status Code	Content Type
errors.ErrorResponse	400, 403, 404, 409	application/json
errors.APIError	4XX, 5XX	/

deleteStream

Delete a stream.

Example Usage

import { S2 } from "@s2-dev/streamstore";

const s2 = new S2({
  accessToken: process.env["S2_ACCESS_TOKEN"] ?? "",
});

async function run() {
  await s2.streams.deleteStream({
    stream: "<value>",
    s2Basin: "<value>",
  });


}

run();

Standalone function

The standalone function version of this method:

import { S2Core } from "@s2-dev/streamstore/core.js";
import { streamsDeleteStream } from "@s2-dev/streamstore/funcs/streamsDeleteStream.js";

// Use `S2Core` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const s2 = new S2Core({
  accessToken: process.env["S2_ACCESS_TOKEN"] ?? "",
});

async function run() {
  const res = await streamsDeleteStream(s2, {
    stream: "<value>",
    s2Basin: "<value>",
  });
  if (res.ok) {
    const { value: result } = res;
    
  } else {
    console.log("streamsDeleteStream failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description
`request`	operations.DeleteStreamRequest	✔️	The request object to use for the request.
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.
`options.serverURL`	string	➖	An optional server URL to use.

Response

Promise<void>

Errors

Error Type	Status Code	Content Type
errors.ErrorResponse	400, 403, 404	application/json
errors.APIError	4XX, 5XX	/

reconfigureStream

Reconfigure a stream.

Example Usage

import { S2 } from "@s2-dev/streamstore";

const s2 = new S2({
  accessToken: process.env["S2_ACCESS_TOKEN"] ?? "",
});

async function run() {
  const result = await s2.streams.reconfigureStream({
    stream: "<value>",
    s2Basin: "<value>",
    streamReconfiguration: {},
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { S2Core } from "@s2-dev/streamstore/core.js";
import { streamsReconfigureStream } from "@s2-dev/streamstore/funcs/streamsReconfigureStream.js";

// Use `S2Core` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const s2 = new S2Core({
  accessToken: process.env["S2_ACCESS_TOKEN"] ?? "",
});

async function run() {
  const res = await streamsReconfigureStream(s2, {
    stream: "<value>",
    s2Basin: "<value>",
    streamReconfiguration: {},
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("streamsReconfigureStream failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description
`request`	operations.ReconfigureStreamRequest	✔️	The request object to use for the request.
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.
`options.serverURL`	string	➖	An optional server URL to use.

Response

Promise<components.StreamConfig>

Errors

Error Type	Status Code	Content Type
errors.ErrorResponse	400, 403, 404, 409	application/json
errors.APIError	4XX, 5XX	/

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!