danog/asyncConstruct
1
0
Fork 0
mirror of https://github.com/danog/asyncConstruct.git synced 2024-11-26 18:54:38 +01:00
Code Issues Projects Releases Wiki Activity

Update

Browse Source
This commit is contained in:
Daniil Gentili 2020-07-31 15:44:16 +02:00
parent 9b114ca8b7
commit 4ef54ad73b
Signed by: danog
GPG Key ID: 8C1BE3B34B230CA7
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -28,15 +28,15 @@ composer require danog/async-construct
Simply `use` this trait in your class, and define a `__construct_async` async method.
The trait will automatically run the async method on construction, and expose a set of APIs to wait on the result of the constructor for initialization.
### `init()`
#### `init()`
Will blockingly wait for execution of the async constructor, returning its return value.
### `initAsynchronously()`
#### `initAsynchronously()`
Will return a promise that, when `yield`ed, will wait for and return the return value of the constructor.
### `inited()`
#### `inited()`
Returns a boolean, indicating whether the class was initialized or not.
@ -54,15 +54,15 @@ Exactly like [AsyncConstruct], except that the blocking `init()` function will b
Simply `use` this trait in your class, and define a `__wakeup_async` async method.
The trait will automatically run the async method on deserialization, and expose a set of APIs to wait on the result of the wakeup function for re-initialization.
### `wakeup()`
#### `wakeup()`
Will blockingly wait for execution of the async wakeup function, returning its return value.
### `wakeupAsynchronously()`
#### `wakeupAsynchronously()`
Will return a promise that, when `yield`ed, will wait for and return the return value of the wakeup function.
### `wokenUp()`
#### `wokenUp()`
Returns a boolean, indicating whether the class was initialized or not.