Skip to content

Commit ceca680

Browse files
committed
add typedoc comments on AuthenticatedRequest
1 parent a67b93b commit ceca680

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

src/AuthenticatedRequest.ts

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,22 @@
11
import {Authorisation} from "./auth/Authorisation.js";
22
import {Permissible} from "./auth/Permissible.js";
3+
import {Permission} from "./auth/Permission.js";
34
import {Request} from "./Request.js";
45

6+
/**
7+
* A request with available {@link Authorisation}.
8+
*/
59
export class AuthenticatedRequest<A> extends Request<A> implements Permissible {
10+
/**
11+
* This request’s authorisation.
12+
*/
613
public readonly authorisation: Authorisation<A>;
14+
15+
/**
16+
* Create a new authenticated request.
17+
* @param authorisation
18+
* @param args The arguments to pass to the {@link Request} constructor.
19+
*/
720
public constructor(
821
authorisation: Authorisation<A>,
922
...args: ConstructorParameters<typeof Request<A>>

0 commit comments

Comments
 (0)