Brunobkr/llama.cpp_AlgMor24_github

1/**2 * The type of error that occurred.3 * @public4 */5export declare type ErrorType =6  | "invalid-retry"7  | "unknown-field"8  | "max-buffer-size-exceeded";9 10/**11 * A parsed EventSource message event12 *13 * @public14 */15export declare interface EventSourceMessage {16  /**17   * The event type sent from the server. Note that this differs from the browser `EventSource`18   * implementation in that browsers will default this to `message`, whereas this parser will19   * leave this as `undefined` if not explicitly declared.20   */21  event?: string | undefined;22  /**23   * ID of the message, if any was provided by the server. Can be used by clients to keep the24   * last received message ID in sync when reconnecting.25   */26  id?: string | undefined;27  /**28   * The data received for this message29   */30  data: string;31}32 33/**34 * A TransformStream that ingests a stream of strings and produces a stream of `EventSourceMessage`.35 *36 * @example Basic usage37 * ```38 * const eventStream =39 *   response.body40 *     .pipeThrough(new TextDecoderStream())41 *     .pipeThrough(new EventSourceParserStream())42 * ```43 *44 * @example Terminate stream on parsing errors45 * ```46 * const eventStream =47 *  response.body48 *   .pipeThrough(new TextDecoderStream())49 *   .pipeThrough(new EventSourceParserStream({onError: 'terminate'}))50 * ```51 *52 * @public53 */54export declare class EventSourceParserStream extends TransformStream<55  string,56  EventSourceMessage57> {58  constructor({ onError, onRetry, onComment, maxBufferSize }?: StreamOptions);59}60 61/**62 * Error thrown when encountering an issue during parsing.63 *64 * @public65 */66export declare class ParseError extends Error {67  /**68   * The type of error that occurred.69   */70  type: ErrorType;71  /**72   * In the case of an unknown field encountered in the stream, this will be the field name.73   */74  field?: string | undefined;75  /**76   * In the case of an unknown field encountered in the stream, this will be the value of the field.77   */78  value?: string | undefined;79  /**80   * The line that caused the error, if available.81   */82  line?: string | undefined;83  constructor(84    message: string,85    options: {86      type: ErrorType;87      field?: string;88      value?: string;89      line?: string;90    },91  );92}93 94/**95 * Options for the EventSourceParserStream.96 *97 * @public98 */99export declare interface StreamOptions {100  /**101   * Behavior when a parsing error occurs.102   *103   * - A custom function can be provided to handle the error.104   * - `'terminate'` will error the stream and stop parsing.105   * - Any other value will ignore the error and continue parsing.106   *107   * @defaultValue `undefined`108   */109  onError?: ("terminate" | ((error: Error) => void)) | undefined;110  /**111   * Callback for when a reconnection interval is sent from the server.112   *113   * @param retry - The number of milliseconds to wait before reconnecting.114   */115  onRetry?: ((retry: number) => void) | undefined;116  /**117   * Callback for when a comment is encountered in the stream.118   *119   * @param comment - The comment encountered in the stream.120   */121  onComment?: ((comment: string) => void) | undefined;122  /**123   * Maximum number of characters the parser is allowed to buffer across calls to `feed()`.124   * See {@link ParserConfig.maxBufferSize} for details.125   *126   * When the limit is exceeded, the stream is always errored (regardless of the `onError`127   * setting) since the underlying parser is unrecoverable without a `reset()`.128   *129   * @defaultValue `undefined` (unbounded)130   */131  maxBufferSize?: number | undefined;132}133 134export {};135