1+ <!DOCTYPE html>
2+ < html lang ="en ">
3+ < head >
4+
5+ < meta charset ="utf-8 ">
6+ < title > BinaryParseStream - Documentation</ title >
7+
8+
9+ < script src ="scripts/prettify/prettify.js "> </ script >
10+ < script src ="scripts/prettify/lang-css.js "> </ script >
11+ <!--[if lt IE 9]>
12+ <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
13+ <![endif]-->
14+ < link type ="text/css " rel ="stylesheet " href ="styles/prettify.css ">
15+ < link type ="text/css " rel ="stylesheet " href ="styles/jsdoc.css ">
16+ < script src ="scripts/nav.js " defer > </ script >
17+
18+ < meta name ="viewport " content ="width=device-width, initial-scale=1.0 ">
19+ </ head >
20+ < body >
21+
22+ < input type ="checkbox " id ="nav-trigger " class ="nav-trigger " />
23+ < label for ="nav-trigger " class ="navicon-button x ">
24+ < div class ="navicon "> </ div >
25+ </ label >
26+
27+ < label for ="nav-trigger " class ="overlay "> </ label >
28+
29+ < nav >
30+
31+
32+ < h2 > < a href ="index.html "> Home</ a > </ h2 > < h3 > Classes</ h3 > < ul > < li > < a href ="BinaryParseStream.html "> BinaryParseStream</ a > </ li > < li > < a href ="CborMap.html "> CborMap</ a > < ul class ='methods '> < li data-type ='method '> < a href ="CborMap.html#delete "> delete</ a > </ li > < li data-type ='method '> < a href ="CborMap.html#encodeCBOR "> encodeCBOR</ a > </ li > < li data-type ='method '> < a href ="CborMap.html#entries "> entries</ a > </ li > < li data-type ='method '> < a href ="CborMap.html#forEach "> forEach</ a > </ li > < li data-type ='method '> < a href ="CborMap.html#get "> get</ a > </ li > < li data-type ='method '> < a href ="CborMap.html#has "> has</ a > </ li > < li data-type ='method '> < a href ="CborMap.html#keys "> keys</ a > </ li > < li data-type ='method '> < a href ="CborMap.html#set "> set</ a > </ li > </ ul > </ li > < li > < a href ="Commented.html "> Commented</ a > < ul class ='methods '> < li data-type ='method '> < a href ="Commented.html#.comment "> comment</ a > </ li > </ ul > </ li > < li > < a href ="Decoder.html "> Decoder</ a > < ul class ='methods '> < li data-type ='method '> < a href ="Decoder.html#close "> close</ a > </ li > < li data-type ='method '> < a href ="Decoder.html#.decodeAll "> decodeAll</ a > </ li > < li data-type ='method '> < a href ="Decoder.html#.decodeAllSync "> decodeAllSync</ a > </ li > < li data-type ='method '> < a href ="Decoder.html#.decodeFirst "> decodeFirst</ a > </ li > < li data-type ='method '> < a href ="Decoder.html#.decodeFirstSync "> decodeFirstSync</ a > </ li > < li data-type ='method '> < a href ="Decoder.html#.nullcheck "> nullcheck</ a > </ li > </ ul > </ li > < li > < a href ="Diagnose.html "> Diagnose</ a > < ul class ='methods '> < li data-type ='method '> < a href ="Diagnose.html#.diagnose "> diagnose</ a > </ li > </ ul > </ li > < li > < a href ="Encoder.html "> Encoder</ a > < ul class ='methods '> < li data-type ='method '> < a href ="Encoder.html#addSemanticType "> addSemanticType</ a > </ li > < li data-type ='method '> < a href ="Encoder.html#pushAny "> pushAny</ a > </ li > < li data-type ='method '> < a href ="Encoder.html#removeLoopDetectors "> removeLoopDetectors</ a > </ li > < li data-type ='method '> < a href ="Encoder.html#.encode "> encode</ a > </ li > < li data-type ='method '> < a href ="Encoder.html#.encodeAsync "> encodeAsync</ a > </ li > < li data-type ='method '> < a href ="Encoder.html#.encodeCanonical "> encodeCanonical</ a > </ li > < li data-type ='method '> < a href ="Encoder.html#.encodeIndefinite "> encodeIndefinite</ a > </ li > < li data-type ='method '> < a href ="Encoder.html#.encodeOne "> encodeOne</ a > </ li > < li data-type ='method '> < a href ="Encoder.html#.pushArray "> pushArray</ a > </ li > < li data-type ='method '> < a href ="Encoder.html#.reset "> reset</ a > </ li > </ ul > </ li > < li > < a href ="ObjectRecorder.html "> ObjectRecorder</ a > < ul class ='methods '> < li data-type ='method '> < a href ="ObjectRecorder.html#check "> check</ a > </ li > < li data-type ='method '> < a href ="ObjectRecorder.html#clear "> clear</ a > </ li > < li data-type ='method '> < a href ="ObjectRecorder.html#stop "> stop</ a > </ li > </ ul > </ li > < li > < a href ="SharedValueEncoder.html "> SharedValueEncoder</ a > < ul class ='methods '> < li data-type ='method '> < a href ="SharedValueEncoder.html#clearRecording "> clearRecording</ a > </ li > < li data-type ='method '> < a href ="SharedValueEncoder.html#stopRecording "> stopRecording</ a > </ li > < li data-type ='method '> < a href ="SharedValueEncoder.html#.encode "> encode</ a > </ li > < li data-type ='method '> < a href ="SharedValueEncoder.html#.encodeAsync "> encodeAsync</ a > </ li > < li data-type ='method '> < a href ="SharedValueEncoder.html#.encodeCanonical "> encodeCanonical</ a > </ li > < li data-type ='method '> < a href ="SharedValueEncoder.html#.encodeOne "> encodeOne</ a > </ li > </ ul > </ li > < li > < a href ="Simple.html "> Simple</ a > < ul class ='methods '> < li data-type ='method '> < a href ="Simple.html#encodeCBOR "> encodeCBOR</ a > </ li > < li data-type ='method '> < a href ="Simple.html#toString "> toString</ a > </ li > < li data-type ='method '> < a href ="Simple.html#.decode "> decode</ a > </ li > < li data-type ='method '> < a href ="Simple.html#.isSimple "> isSimple</ a > </ li > </ ul > </ li > < li > < a href ="Tagged.html "> Tagged</ a > < ul class ='methods '> < li data-type ='method '> < a href ="Tagged.html#convert "> convert</ a > </ li > < li data-type ='method '> < a href ="Tagged.html#encodeCBOR "> encodeCBOR</ a > </ li > < li data-type ='method '> < a href ="Tagged.html#toString "> toString</ a > </ li > < li data-type ='method '> < a href ="Tagged.html#.reset "> reset</ a > </ li > </ ul > </ li > </ ul > < h3 > < a href ="global.html "> Global</ a > </ h3 >
33+
34+ </ nav >
35+
36+ < div id ="main ">
37+
38+ < h1 class ="page-title "> BinaryParseStream</ h1 >
39+
40+
41+
42+
43+
44+
45+
46+ < section >
47+
48+ < header >
49+
50+ < h2 >
51+
52+ BinaryParseStream
53+
54+ </ h2 >
55+
56+ < div class ="class-description usertext "> BinaryParseStream is a TransformStream that consumes buffers and outputs
57+ objects on the other end. It expects your subclass to implement a `_parse`
58+ method that is a generator. When your generator yields a number, it'll be
59+ fed a buffer of that length from the input. When your generator returns,
60+ the return value will be pushed to the output side.</ div >
61+
62+
63+ </ header >
64+
65+ < article >
66+
67+ < div class ="container-overview ">
68+
69+
70+
71+
72+ < h2 > Constructor</ h2 >
73+
74+
75+ < h4 class ="name " id ="BinaryParseStream "> < span class ="type-signature "> </ span > new BinaryParseStream< span class ="signature "> (options)</ span > < span class ="type-signature "> </ span > </ h4 >
76+
77+
78+
79+
80+
81+
82+ < dl class ="details ">
83+
84+ < dt class ="tag-description "> Description:</ dt >
85+ < dd class ="tag-description "> < ul class ="dummy "> < li > Creates an instance of BinaryParseStream.</ li > </ ul > </ dd >
86+
87+
88+
89+ < dt class ="tag-source "> Source:</ dt >
90+ < dd class ="tag-source "> < ul class ="dummy "> < li >
91+ < a href ="vendor_binary-parse-stream_index.js.html "> vendor/binary-parse-stream/index.js</ a > , < a href ="vendor_binary-parse-stream_index.js.html#line24 "> line 24</ a >
92+ </ li > </ ul > </ dd >
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+ </ dl >
125+
126+
127+
128+
129+
130+
131+
132+
133+
134+
135+
136+
137+
138+ < h5 class ="h5-parameters "> Parameters:</ h5 >
139+
140+
141+ < table class ="params ">
142+ < thead >
143+ < tr >
144+
145+ < th > Name</ th >
146+
147+
148+ < th > Type</ th >
149+
150+
151+
152+
153+
154+ < th class ="last "> Description</ th >
155+ </ tr >
156+ </ thead >
157+
158+ < tbody >
159+
160+
161+ < tr >
162+
163+ < td class ="name "> < code > options</ code > </ td >
164+
165+
166+ < td class ="type ">
167+
168+
169+ < span class ="param-type "> stream.TransformOptions</ span >
170+
171+
172+
173+
174+ </ td >
175+
176+
177+
178+
179+
180+ < td class ="description last "> Stream options.</ td >
181+ </ tr >
182+
183+
184+ </ tbody >
185+ </ table >
186+
187+
188+
189+
190+
191+
192+
193+
194+
195+
196+
197+
198+
199+
200+
201+
202+
203+
204+
205+
206+ </ div >
207+
208+
209+
210+ < h3 class ="subsection-title "> Extends</ h3 >
211+
212+
213+
214+
215+ < ul >
216+ < li > stream.Transform</ li >
217+ </ ul >
218+
219+
220+
221+
222+
223+
224+
225+ < h3 class ="subsection-title "> Classes</ h3 >
226+
227+ < dl >
228+ < dt > < a href ="BinaryParseStream.html "> BinaryParseStream</ a > </ dt >
229+ < dd > </ dd >
230+ </ dl >
231+
232+
233+
234+
235+
236+
237+
238+
239+
240+
241+
242+
243+
244+
245+
246+ </ article >
247+
248+ </ section >
249+
250+
251+
252+
253+
254+
255+ </ div >
256+
257+ < br class ="clear ">
258+
259+ < footer >
260+ Documentation generated by < a href ="https://github.com/jsdoc3/jsdoc "> JSDoc 4.0.4</ a > using the < a href ="https://github.com/clenemt/docdash "> docdash</ a > theme.
261+ </ footer >
262+
263+ < script > prettyPrint ( ) ; </ script >
264+ < script src ="scripts/polyfill.js "> </ script >
265+ < script src ="scripts/linenumber.js "> </ script >
266+
267+
268+
269+ </ body >
270+ </ html >
0 commit comments