---
title: CsvStream
slug: data-platform/connect-platform/app-sdk-api-reference-classes-csvstream
createdAt: 2026-08-05T20:06:34.632Z
---

[OCP App SDK](docId\:gxEU_0AA37IEZJK-uoVcT)

***

[OCP App SDK](docId\:gxEU_0AA37IEZJK-uoVcT) / CsvStream

# Class: CsvStream\<T>

Defined in: [src/util/CsvStream.ts:19](https://github.com/ZaiusInc/app-sdk/blob/8c7209817facb226c91abb960e6d54a7692b9aa2/src/util/CsvStream.ts#L19)

Superclass of stream file reader with the main
logic involve in processing a file line by line

## Extends

- [`` `FileStream` ``](docId\:IaTlsPBZINR77EAGdOEKd)\<`T`, `Options`>

## Type Parameters

### T

`T`

## Constructors

### Constructor

:::BlockQuote
**new CsvStream**\<`T`>(`streamBuilder`, `rowProcessor`, `options`): `CsvStream`\<`T`>
:::

Defined in: [src/util/CsvStream.ts:58](https://github.com/ZaiusInc/app-sdk/blob/8c7209817facb226c91abb960e6d54a7692b9aa2/src/util/CsvStream.ts#L58)

### Parameters

### streamBuilder

[`` `FileReadableStreamBuilder` ``](docId\:yxB8TaJT1kdlRKojsLN6g)

### rowProcessor

[`` `CsvRowProcessor` ``](docId:0lflDcBpZjbyFHWLpBXQh)\<`T`>

### options

`Options` = `{}`

### Returns

`CsvStream`\<`T`>

### Overrides

[`` `FileStream` ``](docId\:IaTlsPBZINR77EAGdOEKd).[`` `constructor` ``](<./#function Object() \{ \[native code] }>)

## Accessors

### isFinished

### Get Signature

:::BlockQuote
**get** **isFinished**(): `boolean`
:::

Defined in: [src/util/FileStream.ts:44](https://github.com/ZaiusInc/app-sdk/blob/8c7209817facb226c91abb960e6d54a7692b9aa2/src/util/FileStream.ts#L44)

### Returns

`boolean`

### Inherited from

[`` `FileStream` ``](docId\:IaTlsPBZINR77EAGdOEKd).[`` `isFinished` ``](docId\:wPncjf6QwaPMeEmbswmmx)

## Methods

### fastforward()

:::BlockQuote
**fastforward**(`target`): `Promise`\<`null` | `string`>
:::

Defined in: [src/util/FileStream.ts:48](https://github.com/ZaiusInc/app-sdk/blob/8c7209817facb226c91abb960e6d54a7692b9aa2/src/util/FileStream.ts#L48)

### Parameters

### target

`string`

### Returns

`Promise`\<`null` | `string`>

### Inherited from

[`` `FileStream` ``](docId\:IaTlsPBZINR77EAGdOEKd).[`` `fastforward` ``](docId\:wPncjf6QwaPMeEmbswmmx)

***

### processSome()

:::BlockQuote
**processSome**(): `Promise`\<`null` | `string`>
:::

Defined in: [src/util/FileStream.ts:53](https://github.com/ZaiusInc/app-sdk/blob/8c7209817facb226c91abb960e6d54a7692b9aa2/src/util/FileStream.ts#L53)

### Returns

`Promise`\<`null` | `string`>

### Inherited from

[`` `FileStream` ``](docId\:IaTlsPBZINR77EAGdOEKd).[`` `processSome` ``](docId\:wPncjf6QwaPMeEmbswmmx)

***

### fromStream()

:::BlockQuote
`static` **fromStream**\<`T`>(`stream`, `processor`, `options`): `CsvStream`\<`T`>
:::

Defined in: [src/util/CsvStream.ts:27](https://github.com/ZaiusInc/app-sdk/blob/8c7209817facb226c91abb960e6d54a7692b9aa2/src/util/CsvStream.ts#L27)

Build a CsvStream from an existing ReadableStream.

### Type Parameters

### T

`T`

### Parameters

### stream

`ReadableStream`

source stream for the csv data

### processor

[`` `CsvRowProcessor` ``](docId:0lflDcBpZjbyFHWLpBXQh)\<`T`>

the row processor

### options

`Options` = `{}`

options to provide the underlying parser,
see [https://github.com/mafintosh/csv-parser#csvoptions--headers](https://github.com/mafintosh/csv-parser#csvoptions--headers)

### Returns

`CsvStream`\<`T`>

***

### fromUrl()

:::BlockQuote
`static` **fromUrl**\<`T`>(`url`, `processor`, `options`): `CsvStream`\<`T`>
:::

Defined in: [src/util/CsvStream.ts:42](https://github.com/ZaiusInc/app-sdk/blob/8c7209817facb226c91abb960e6d54a7692b9aa2/src/util/CsvStream.ts#L42)

Build a CsvStream that reads from a web resource.

### Type Parameters

### T

`T`

### Parameters

### url

`string`

source url for the csv data

### processor

[`` `CsvRowProcessor` ``](docId:0lflDcBpZjbyFHWLpBXQh)\<`T`>

the row processor

### options

`Options` = `{}`

options to provide the underlying parser,
see [https://github.com/mafintosh/csv-parser#csvoptions--headers](https://github.com/mafintosh/csv-parser#csvoptions--headers)

### Returns

`CsvStream`\<`T`>