@twurple/auth/lib/AccessToken.d.ts

Authenticate with Twitch and stop caring about refreshing tokens.

/**
 * Represents the data of an OAuth access token returned by Twitch.
 */
export interface AccessToken {
    /**
     * The access token which is necessary for every request to the Twitch API.
     */
    accessToken: string;
    /**
     * The refresh token which is necessary to refresh the access token once it expires.
     */
    refreshToken: string | null;
    /**
     * The scope the access token is valid for, i.e. what the token enables you to do.
     */
    scope: string[];
    /**
     * The time, in seconds from the obtainment date, when the access token expires.
     *
     * May be `null`, in which case the token does not expire.
     * This can only be the case with very old Client IDs.
     *
     * This does **not** honor the expiry grace period; it contains the exact value from Twitch.
     */
    expiresIn: number | null;
    /**
     * The date when the token was obtained, in epoch milliseconds.
     */
    obtainmentTimestamp: number;
}
/**
 * Represents the data of an OAuth access token returned by Twitch, together with the ID of the user it represents.
 *
 * @inheritDoc
 */
export interface AccessTokenWithUserId extends AccessToken {
    /**
     * The ID of the user represented by the token.
     */
    userId: string;
}
/**
 * Represents the data of an OAuth access token returned by Twitch, together with the ID of the user it represents,
 * if it's not an app access token.
 *
 * @inheritDoc
 */
export interface AccessTokenMaybeWithUserId extends AccessToken {
    /**
     * The ID of the user represented by the token, or undefined if it's an app access token.
     */
    userId?: string;
}
/**
 * The part of an access token that is required to calculate expiredness.
 */
export type ExpireableAccessToken = Pick<AccessToken, 'expiresIn' | 'obtainmentTimestamp'>;
/**
 * Calculates the date when the access token will expire.
 *
 * A one-minute grace period is applied for smooth handling of API latency.
 *
 * May be `null`, in which case the token does not expire.
 * This can only be the case with very old Client IDs.
 *
 * @param token The access token.
 */
export declare function getExpiryDateOfAccessToken(token: ExpireableAccessToken): Date | null;
/**
 * Calculates whether the given access token is expired.
 *
 * A one-minute grace period is applied for smooth handling of API latency.
 *
 * @param token The access token.
 */
export declare function accessTokenIsExpired(token: ExpireableAccessToken): boolean;
//# sourceMappingURL=AccessToken.d.ts.map