Skip to content

Commit a5b772d

Browse files
committed
Added note about enums.
1 parent fd5ba18 commit a5b772d

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

AGENTS.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -244,6 +244,15 @@ where `T` is the type of the expected result.
244244
callback function (lambda or function pointer) that will be invoked when
245245
the future completes. The callback receives the completed future as an
246246
argument.
247+
* k?????Fn_* enums: A list of each SDK's asynchronous functions is usually
248+
kept in an enum in that SDK. For example, all of Auth's asynchronous
249+
functions are named kAuthFn_* and kUserFn_*. Only asynchronous operations
250+
(which return a Future) need to be in those function enums; these are used
251+
internally to hold a reference to the FutureHandle for the *LastResult()
252+
methods. If you add a new asynchronous operation, it should be added to
253+
that enum, and that ID should be used for all of the internal FutureApi
254+
operations. Non-async functions never need to touch this.
255+
247256

248257
### Core Classes and Operations (Examples from Auth and Database)
249258

0 commit comments

Comments
 (0)