docs: typo #1480
docs: typo #1480
Conversation
| @@ -299,7 +299,7 @@ The SDK provides convenient methods for exiting Actors: | |||
|
|
|||
| 1. Use `exit()` with custom messages to inform users about the Actor's achievements or issues. | |||
|
|
|||
| 2. The `exit()` method emits `exit` event allowing components to perform cleanup or state persistence. | |||
| 2. The `fail()` method emits `exit` event allowing components to perform cleanup or state persistence. | |||
There was a problem hiding this comment.
the fail method calls the exit method. both of them will issue process.exit() unless explicitly told not to (or better say, the exit method is the one doing this, fail just calls it), the difference is fail defaults to exit code 1.
https://github.com/apify/apify-sdk-js/blob/master/packages/apify/src/actor.ts#L292-L294
(and both methods emit the exit event too, the only difference really is in the exit code)
There was a problem hiding this comment.
So we could change it to :
| 2. The `fail()` method emits `exit` event allowing components to perform cleanup or state persistence. | |
| 1. Use `exit()`/`fail()` with custom messages to inform users about the Actor's achievements or issues. | |
| 2. The `exit()`/`fail()` method emits `exit` event allowing components to perform cleanup or state persistence. |
?
Or am I misunderstanding it?
There was a problem hiding this comment.
i am not sure if we should have it written this way with the two bullet points. all the fail method is doing is calling exit with exit code 1. i think that's what we should say in the docs, so its clear its just a shortcut with an error exit code.
There was a problem hiding this comment.
Righ then maybe something like this, with bullets instead of ordered list
| 2. The `fail()` method emits `exit` event allowing components to perform cleanup or state persistence. | |
| - Use `exit()` with custom messages to inform users about the Actor's achievements or issues. | |
| - Use `fail()` as a shortcut for `exit()` when indicating an error. It defaults to an exit code of `1` and emits the `exit` event, allowing components to perform cleanup or state persistence. | |
| - The `exit()` method also emits the `exit` event, enabling cleanup or state persistence. |
|
why are we still getting 401's? I thought the package issue has been solved? |
|
Not really, we'll first have to update the use in here. And we cannot do that, because the latest version of the public packages are broken, they are set to be ESM, but they don't respect what that actually means (having extensions in all imports in particular), so it's not usable for us right now. I'll update the repository to use them once it's resolved. |
|
ok makes sense, thank you! |
add information about `fail()` method being shortcut for `exit()` remake ordered list to bullet list mention that both methods emit `exit` event
No description provided.