Skip to content

Commit 7ce82e0

Browse files
committed
docs(runtime_types): update README return typing
1 parent dbda58a commit 7ce82e0

File tree

1 file changed

+18
-18
lines changed
  • packages/globe_runtime_ts/runtime_types

1 file changed

+18
-18
lines changed

packages/globe_runtime_ts/runtime_types/README.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ export default defineSdk({
6060

6161
These helpers define functions that send a single value back to Dart.
6262

63-
#### `returnString<State, Args>(fn)`
63+
#### `returnString(fn)`
6464

6565
Returns a string to Dart (Dart: `String`, JS: `string`).
6666

@@ -75,7 +75,7 @@ const fetchUser = returnString(
7575
);
7676
```
7777

78-
#### `returnInt<State, Args>(fn)`
78+
#### `returnInt(fn)`
7979

8080
Returns an integer to Dart (Dart: `int`, JS: `number`).
8181

@@ -88,7 +88,7 @@ const calculateSum = returnInt(
8888
);
8989
```
9090

91-
#### `returnDouble<State, Args>(fn)`
91+
#### `returnDouble(fn)`
9292

9393
Returns a double-precision number to Dart (Dart: `double`, JS: `number`).
9494

@@ -101,11 +101,11 @@ const calculateAverage = returnDouble(
101101
);
102102
```
103103

104-
#### `returnNumber<State, Args>(fn)`
104+
#### `returnNumber(fn)`
105105

106106
Returns a generic number to Dart (Dart: `num`, JS: `number`).
107107

108-
#### `returnBoolean<State, Args>(fn)`
108+
#### `returnBoolean(fn)`
109109

110110
Returns a boolean to Dart (Dart: `bool`, JS: `boolean`).
111111

@@ -118,7 +118,7 @@ const isValid = returnBoolean(
118118
);
119119
```
120120

121-
#### `returnUint8Array<State, Args>(fn)`
121+
#### `returnUint8Array(fn)`
122122

123123
Returns binary data to Dart (Dart: `List<int>`, JS: `Uint8Array`).
124124

@@ -134,7 +134,7 @@ const generateBytes = returnUint8Array(
134134
);
135135
```
136136

137-
#### `returnMap<State, Args>(fn)`
137+
#### `returnMap(fn)`
138138

139139
Returns a map/object to Dart (Dart: `Map<dynamic, dynamic>`, JS: `object`).
140140

@@ -150,7 +150,7 @@ const getMetadata = returnMap(
150150
);
151151
```
152152

153-
#### `returnList<State, Args>(fn)`
153+
#### `returnList(fn)`
154154

155155
Returns a list to Dart (Dart: `List<dynamic>`, JS: `object`).
156156

@@ -166,7 +166,7 @@ const getItems = returnList(
166166
);
167167
```
168168

169-
#### `returnSet<State, Args>(fn)`
169+
#### `returnSet(fn)`
170170

171171
Returns a set to Dart (Dart: `Set<dynamic>`, JS: `object`).
172172

@@ -186,7 +186,7 @@ const getUniqueValues = returnSet(
186186

187187
These helpers define functions that stream multiple values back to Dart.
188188

189-
#### `streamString<State, Args>(fn)`
189+
#### `streamString(fn)`
190190

191191
Streams strings to Dart (Dart: `Stream<String>`, JS: `string`).
192192

@@ -202,27 +202,27 @@ const streamMessages = streamString(
202202
);
203203
```
204204

205-
#### `streamInt<State, Args>(fn)`
205+
#### `streamInt(fn)`
206206

207207
Streams integers to Dart (Dart: `Stream<int>`, JS: `number`).
208208

209-
#### `streamDouble<State, Args>(fn)`
209+
#### `streamDouble(fn)`
210210

211211
Streams doubles to Dart (Dart: `Stream<double>`, JS: `number`).
212212

213-
#### `streamNumber<State, Args>(fn)`
213+
#### `streamNumber(fn)`
214214

215215
Streams numbers to Dart (Dart: `Stream<num>`, JS: `number`).
216216

217-
#### `streamBoolean<State, Args>(fn)`
217+
#### `streamBoolean(fn)`
218218

219219
Streams booleans to Dart (Dart: `Stream<bool>`, JS: `boolean`).
220220

221-
#### `streamUint8Array<State, Args>(fn)`
221+
#### `streamUint8Array(fn)`
222222

223223
Streams binary data to Dart (Dart: `Stream<List<int>>`, JS: `Uint8Array`).
224224

225-
#### `streamMap<State, Args>(fn)`
225+
#### `streamMap(fn)`
226226

227227
Streams maps to Dart (Dart: `Stream<Map<dynamic, dynamic>>`, JS: `object`).
228228

@@ -242,11 +242,11 @@ const streamUpdates = streamMap(
242242
);
243243
```
244244

245-
#### `streamList<State, Args>(fn)`
245+
#### `streamList(fn)`
246246

247247
Streams lists to Dart (Dart: `Stream<List<dynamic>>`, JS: `object`).
248248

249-
#### `streamSet<State, Args>(fn)`
249+
#### `streamSet(fn)`
250250

251251
Streams sets to Dart (Dart: `Stream<Set<dynamic>>`, JS: `object`).
252252

0 commit comments

Comments
 (0)