`simulateReadableStream()`

simulateReadableStream()

simulateReadableStream은 제공된 값들을 구성 가능한 지연으로 순차적으로 방출하는 ReadableStream을 만드는 유틸리티 함수입니다. 스트리밍 기능 테스트나 시간 지연 데이터 스트림 시뮬레이션에 특히 유용합니다.

출처: 문서

본문

import { simulateReadableStream } from 'ai';

const stream = simulateReadableStream({
  chunks: ['Hello', ' ', 'World'],
  initialDelayInMs: 100,
  chunkDelayInMs: 50,
});

Import

import { simulateReadableStream } from "ai"

API Signature

Parameters (파라미터)

  • chunks: T[] (필수) — 스트림이 방출할 값 배열입니다.
  • initialDelayInMs: number | null (선택) — 첫 번째 값을 방출하기 전의 초기 지연(밀리초)입니다. 기본값은 0입니다. 초기 지연을 완전히 건너뛰려면 null로 설정하세요.
  • chunkDelayInMs: number | null (선택) — 각 값을 방출하는 사이의 지연(밀리초)입니다. 기본값은 0입니다. 청크 사이의 지연을 건너뛰려면 null로 설정하세요.

Returns (반환값)

다음과 같은 ReadableStream<T>를 반환합니다.

  • 제공된 chunks 배열의 각 값을 순차적으로 방출
  • 첫 번째 값을 방출하기 전에 initialDelayInMs만큼 대기 (null이 아닐 때)
  • 후속 값을 방출하는 사이에 chunkDelayInMs만큼 대기 (null이 아닐 때)
  • 모든 청크가 방출된 후 자동으로 닫힘

Type Parameters (타입 파라미터)

  • T: 청크 배열에 있고 스트림이 방출하는 값의 유형입니다.

Examples (예제)

기본 사용법

const stream = simulateReadableStream({
  chunks: ['Hello', ' ', 'World'],
});

지연과 함께

const stream = simulateReadableStream({
  chunks: ['Hello', ' ', 'World'],
  initialDelayInMs: 1000, // Wait 1 second before first chunk
  chunkDelayInMs: 500, // Wait 0.5 seconds between chunks
});

지연 없이

const stream = simulateReadableStream({
  chunks: ['Hello', ' ', 'World'],
  initialDelayInMs: null, // No initial delay
  chunkDelayInMs: null, // No delay between chunks
});

더 알아보기 (Learn more)