-
Notifications
You must be signed in to change notification settings - Fork 180
/
EventStream.yml
153 lines (153 loc) · 4.73 KB
/
EventStream.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
### YamlMime:TSType
name: EventStream
uid: '@azure/openai.EventStream'
package: '@azure/openai'
summary: A readable stream that is iterable and disposable.
fullName: EventStream<T>
remarks: ''
isDeprecated: false
type: interface
inheritedProperties:
- name: locked
uid: '@azure/openai.EventStream.locked'
package: '@azure/openai'
summary: ''
fullName: locked
remarks: ''
isDeprecated: false
syntax:
content: 'locked: boolean'
return:
description: ''
type: boolean
inheritanceDescription: <b>Inherited From</b> ReadableStream.locked
inheritedMethods:
- name: cancel(any)
uid: '@azure/openai.EventStream.cancel'
package: '@azure/openai'
summary: ''
remarks: ''
isDeprecated: false
syntax:
content: 'function cancel(reason?: any): Promise<void>'
parameters:
- id: reason
type: any
description: ''
return:
description: ''
type: Promise<void>
inheritanceDescription: <b>Inherited From</b> ReadableStream.cancel
- name: getReader()
uid: '@azure/openai.EventStream.getReader_1'
package: '@azure/openai'
summary: ''
remarks: ''
isDeprecated: false
syntax:
content: 'function getReader(): ReadableStreamDefaultReader<T>'
return:
description: ''
type: ReadableStreamDefaultReader<T>
inheritanceDescription: <b>Inherited From</b> ReadableStream.getReader
- name: getReader(ReadableStreamGetReaderOptions)
uid: '@azure/openai.EventStream.getReader_2'
package: '@azure/openai'
summary: ''
remarks: ''
isDeprecated: false
syntax:
content: >-
function getReader(options?: ReadableStreamGetReaderOptions):
ReadableStreamReader<T>
parameters:
- id: options
type: ReadableStreamGetReaderOptions
description: ''
return:
description: ''
type: ReadableStreamReader<T>
inheritanceDescription: <b>Inherited From</b> ReadableStream.getReader
- name: 'getReader({ mode: "byob" })'
uid: '@azure/openai.EventStream.getReader'
package: '@azure/openai'
summary: ''
remarks: ''
isDeprecated: false
syntax:
content: 'function getReader(options: { mode: "byob" }): ReadableStreamBYOBReader'
parameters:
- id: options
type: '{ mode: "byob" }'
description: ''
return:
description: ''
type: ReadableStreamBYOBReader
inheritanceDescription: <b>Inherited From</b> ReadableStream.getReader
- name: pipeThrough<T>(ReadableWritablePair<T, T>, StreamPipeOptions)
uid: '@azure/openai.EventStream.pipeThrough'
package: '@azure/openai'
summary: ''
remarks: ''
isDeprecated: false
syntax:
content: >-
function pipeThrough<T>(transform: ReadableWritablePair<T, T>, options?:
StreamPipeOptions): ReadableStream<T>
parameters:
- id: transform
type: ReadableWritablePair<T, T>
description: ''
- id: options
type: StreamPipeOptions
description: ''
return:
description: ''
type: ReadableStream<T>
inheritanceDescription: <b>Inherited From</b> ReadableStream.pipeThrough
- name: pipeTo(WritableStream<T>, StreamPipeOptions)
uid: '@azure/openai.EventStream.pipeTo'
package: '@azure/openai'
summary: ''
remarks: ''
isDeprecated: false
syntax:
content: >-
function pipeTo(destination: WritableStream<T>, options?:
StreamPipeOptions): Promise<void>
parameters:
- id: destination
type: WritableStream<T>
description: ''
- id: options
type: StreamPipeOptions
description: ''
return:
description: ''
type: Promise<void>
inheritanceDescription: <b>Inherited From</b> ReadableStream.pipeTo
- name: tee()
uid: '@azure/openai.EventStream.tee'
package: '@azure/openai'
summary: ''
remarks: ''
isDeprecated: false
syntax:
content: 'function tee(): [ReadableStream<T>, ReadableStream<T>]'
return:
description: ''
type: '[ReadableStream<T>, ReadableStream<T>]'
inheritanceDescription: <b>Inherited From</b> ReadableStream.tee
- name: '[asyncIterator]()'
uid: '@azure/openai.EventStream.[asyncIterator]'
package: '@azure/openai'
summary: ''
remarks: ''
isDeprecated: false
syntax:
content: 'function [asyncIterator](): AsyncIterator<T, any, undefined>'
return:
description: ''
type: AsyncIterator<T, any, undefined>
inheritanceDescription: <b>Inherited From</b> AsyncIterable.__@asyncIterator@367
extends: ReadableStream<T>,AsyncIterable<T>