mirror of
https://github.com/CommunitySolidServer/CommunitySolidServer.git
synced 2024-10-03 14:55:10 +00:00
docs: Update AsyncHandler documentation.
This commit is contained in:
parent
a75d5aa63c
commit
c9d09abebc
@ -3,9 +3,9 @@
|
||||
*/
|
||||
export abstract class AsyncHandler<TIn = void, TOut = void> {
|
||||
/**
|
||||
* Checks if the input data can be handled by this class.
|
||||
* Throws an error if it can't handle the data.
|
||||
* @param input - Input data that could potentially be handled.
|
||||
* Checks if the input can be handled by this class.
|
||||
* If it cannot handle the input, rejects with an error explaining why.
|
||||
* @param input - Input that could potentially be handled.
|
||||
*
|
||||
* @returns A promise resolving if the input can be handled, rejecting with an Error if not.
|
||||
*/
|
||||
@ -15,26 +15,24 @@ export abstract class AsyncHandler<TIn = void, TOut = void> {
|
||||
}
|
||||
|
||||
/**
|
||||
* Handles the given input. This should only be done if the {@link canHandle} function returned `true`.
|
||||
* Therefore, consider using the {@link handleSafe} function instead.
|
||||
* @param input - Input data that needs to be handled.
|
||||
* Handles the given input. This may only be called if {@link canHandle} did not reject.
|
||||
* When unconditionally calling both in sequence, consider {@link handleSafe} instead.
|
||||
* @param input - Input that needs to be handled.
|
||||
*
|
||||
* @returns A promise resolving when the handling is finished. Return value depends on the given type.
|
||||
* @returns A promise resolving when handling is finished.
|
||||
*/
|
||||
public abstract handle(input: TIn): Promise<TOut>;
|
||||
|
||||
/**
|
||||
* Helper function that first runs the canHandle function followed by the handle function.
|
||||
* Throws the error of the {@link canHandle} function if the data can't be handled,
|
||||
* or returns the result of the {@link handle} function otherwise.
|
||||
* Helper function that first runs {@link canHandle} followed by {@link handle}.
|
||||
* Throws the error of {@link canHandle} if the data cannot be handled,
|
||||
* or returns the result of {@link handle} otherwise.
|
||||
* @param input - Input data that will be handled if it can be handled.
|
||||
*
|
||||
* @returns A promise resolving if the input can be handled, rejecting with an Error if not.
|
||||
* Return value depends on the given type.
|
||||
*/
|
||||
public async handleSafe(input: TIn): Promise<TOut> {
|
||||
await this.canHandle(input);
|
||||
|
||||
return this.handle(input);
|
||||
}
|
||||
}
|
||||
|
Loading…
x
Reference in New Issue
Block a user