Skip to content

Export type for return of getCapabilities() #3266

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hughns merged 4 commits into from
Apr 6, 2023
Merged

Export type for return of getCapabilities() #3266

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9a6a5ec
Export type for return of getCapabilities()
hughns Apr 6, 2023
5ee3a4b
Export type for return of getCapabilities()
hughns Apr 6, 2023
ad42e6a
Merge branch 'hughns/expose-capabilities-type' of https://github.com/…
hughns Apr 6, 2023
25dc8f5
Rename to Capabilities
hughns Apr 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions src/client.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -492,7 +492,11 @@ export interface IMSC3882GetLoginTokenCapability extends ICapability {}

export const UNSTABLE_MSC3882_CAPABILITY = new UnstableValue("m.get_login_token", "org.matrix.msc3882.get_login_token");

interface ICapabilities {
/**
* A representation of the capabilities advertised by a homeserver as defined by
* [Capabilities negotiation](https://spec.matrix.org/v1.6/client-server-api/#get_matrixclientv3capabilities).
*/
export interface Capabilities {
[key: string]: any;
"m.change_password"?: IChangePasswordCapability;
"m.room_versions"?: IRoomVersionsCapability;
Expand Down Expand Up @@ -1231,7 +1235,7 @@ export class MatrixClient extends TypedEventEmitter<EmittedEvents, ClientEventHa
protected serverVersionsPromise?: Promise<IServerVersions>;

public cachedCapabilities?: {
capabilities: ICapabilities;
capabilities: Capabilities;
expiration: number;
};
protected clientWellKnown?: IClientWellKnown;
Expand Down Expand Up @@ -2050,7 +2054,7 @@ export class MatrixClient extends TypedEventEmitter<EmittedEvents, ClientEventHa
* @returns Promise which resolves to the capabilities of the homeserver
* @returns Rejects: with an error response.
*/
public getCapabilities(fresh = false): Promise<ICapabilities> {
public getCapabilities(fresh = false): Promise<Capabilities> {
const now = new Date().getTime();

if (this.cachedCapabilities && !fresh) {
Expand All @@ -2061,7 +2065,7 @@ export class MatrixClient extends TypedEventEmitter<EmittedEvents, ClientEventHa
}

type Response = {
capabilities?: ICapabilities;
capabilities?: Capabilities;
};
return this.http
.authedRequest<Response>(Method.Get, "/capabilities")
Expand Down