From b5e0ef3c53ccccd7d40950ff56372dd7dcc75610 Mon Sep 17 00:00:00 2001 From: ExWeiv GitHub BOT Date: Tue, 26 Mar 2024 00:29:56 +0000 Subject: [PATCH] Build and Generate Docs - BOT --- app/package-lock.json | 4 ++-- docs/index.html | 2 +- docs/interfaces/discord-1.html | 10 +++++----- docs/interfaces/facebook-1.html | 10 +++++----- docs/interfaces/github-1.html | 10 +++++----- docs/interfaces/google-1.html | 10 +++++----- docs/interfaces/steam-1.html | 8 ++++---- docs/modules.html | 2 +- docs/modules/Discord.html | 4 ++-- docs/modules/Facebook.html | 4 ++-- docs/modules/GitHub.html | 4 ++-- docs/modules/Google.html | 4 ++-- docs/modules/Steam.html | 4 ++-- docs/types/AuthResponse.html | 4 ++-- docs/types/Discord.AuthOptions.html | 4 ++-- docs/types/Discord.RedirectURLOptions.html | 4 ++-- docs/types/Discord.TokensOptions.html | 4 ++-- docs/types/Discord.TokensResponse.html | 4 ++-- docs/types/Facebook.AuthOptions.html | 4 ++-- docs/types/Facebook.RedirectURLOptions.html | 4 ++-- docs/types/Facebook.TokensOptions.html | 4 ++-- docs/types/Facebook.TokensResponse.html | 4 ++-- docs/types/GitHub.AuthOptions.html | 4 ++-- docs/types/GitHub.RedirectURLOptions.html | 4 ++-- docs/types/GitHub.TokensOptions.html | 4 ++-- docs/types/GitHub.TokensResponse.html | 4 ++-- docs/types/Google.AuthOptions.html | 4 ++-- docs/types/Google.RedirectURLOptions.html | 4 ++-- docs/types/Google.TokensOptions.html | 4 ++-- docs/types/Google.TokensResponse.html | 4 ++-- docs/types/Steam.AuthOptions.html | 4 ++-- docs/types/Steam.RedirectURLOptions.html | 4 ++-- 32 files changed, 76 insertions(+), 76 deletions(-) diff --git a/app/package-lock.json b/app/package-lock.json index aba428f..bf981fe 100644 --- a/app/package-lock.json +++ b/app/package-lock.json @@ -1,12 +1,12 @@ { "name": "@exweiv/easy-auth", - "version": "0.0.1", + "version": "0.1.0", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@exweiv/easy-auth", - "version": "0.0.1", + "version": "0.1.0", "license": "Apache-2.0", "dependencies": { "@exweiv/wix-secret-helpers": "^0.0.5", diff --git a/docs/index.html b/docs/index.html index d519540..bc3cabe 100644 --- a/docs/index.html +++ b/docs/index.html @@ -3,7 +3,7 @@

Settings

Member Visibility

Theme

On This Page

Easy Auth Setup

Generated using TypeDoc

Interface discord

Read Discord Docs for more info about anything here.

-
interface discord {
    getTokens(options): Promise<Discord.TokensResponse>;
    redirectURL(options): string;
    userAuth(options, client_secret?, access_token?): Promise<AuthResponse>;
}

Methods

getTokens +
interface discord {
    getTokens(options): Promise<Discord.TokensResponse>;
    redirectURL(options): string;
    userAuth(options, client_secret?, access_token?): Promise<AuthResponse>;
}

Methods

getTokens redirectURL userAuth

Methods

getTokens

redirectURL

  • redirectURL(options): string

  • Creates a redirect url for authenticating user via Discord

    +

Returns Promise<Discord.TokensResponse>

redirectURL

  • redirectURL(options): string

  • Creates a redirect url for authenticating user via Discord

    Parameters

    Returns string

userAuth

  • userAuth(options, client_secret?, access_token?): Promise<AuthResponse>

  • Gets user data from Discord

    +

Returns string

userAuth

  • userAuth(options, client_secret?, access_token?): Promise<AuthResponse>

  • Gets user data from Discord

    Parameters

    • options: Discord.AuthOptions

      Options that's used when getting user data from Discord.

    • Optional client_secret: string

      Defaults to undefined, if you don't pass a client_secret API will use Wix Secret Manager to find client_secret named as DiscordClientSecret.

    • Optional access_token: string

      Defaults to undefined, if you don't pass a access_token API will get new one each time.

      -

    Returns Promise<AuthResponse>

Settings

Member Visibility

Theme

On This Page

getTokensredirectURLuserAuth

Generated using TypeDoc
+

Returns Promise<AuthResponse>

Settings

Member Visibility

Theme

On This Page

getTokensredirectURLuserAuth

Generated using TypeDoc

Interface facebook

Read Facebook Docs for more info about anything here.

-
interface facebook {
    authUser(options, client_secret?, access_token?): Promise<AuthResponse>;
    getTokens(options): Promise<Facebook.TokensResponse>;
    redirectURL(options): string;
}

Methods

authUser +
interface facebook {
    authUser(options, client_secret?, access_token?): Promise<AuthResponse>;
    getTokens(options): Promise<Facebook.TokensResponse>;
    redirectURL(options): string;
}

Methods

authUser getTokens redirectURL

Methods

authUser

  • authUser(options, client_secret?, access_token?): Promise<AuthResponse>

  • Gets user data from Facebook

    Parameters

    • options: Facebook.AuthOptions

      Options that's used when getting user data from Facebook.

    • Optional client_secret: string

      Defaults to undefined, if you don't pass a client_secret API will use Wix Secret Manager to find client_secret named as FacebookClientSecret.

    • Optional access_token: string

      Defaults to undefined, if you don't pass a access_token API will get new one each time.

      -

    Returns Promise<AuthResponse>

getTokens

  • getTokens(options): Promise<Facebook.TokensResponse>

  • Gets tokens for API calls to Facebook. Keep in mind Facebook has a different system for tokens. Facebook doesn't have any refresh_tokens instead you exhcnage expired tokens with new ones.

    +

Returns Promise<AuthResponse>

getTokens

  • getTokens(options): Promise<Facebook.TokensResponse>

  • Gets tokens for API calls to Facebook. Keep in mind Facebook has a different system for tokens. Facebook doesn't have any refresh_tokens instead you exhcnage expired tokens with new ones.

    Parameters

    Returns Promise<Facebook.TokensResponse>

redirectURL

  • redirectURL(options): string

  • Creates a redirect url for authenticating user via Facebook

    +

Returns Promise<Facebook.TokensResponse>

redirectURL

  • redirectURL(options): string

  • Creates a redirect url for authenticating user via Facebook

    Parameters

    Returns string

Settings

Member Visibility

Theme

On This Page

authUsergetTokensredirectURL

Generated using TypeDoc
+

Returns string

Settings

Member Visibility

Theme

On This Page

authUsergetTokensredirectURL

Generated using TypeDoc

Interface github

Read GitHub Docs for more info about anything here.

-
interface github {
    authUser(options, client_secret?, access_token?): Promise<AuthResponse>;
    getTokens(options): Promise<GitHub.TokensResponse>;
    redirectURL(options): string;
}

Methods

authUser +
interface github {
    authUser(options, client_secret?, access_token?): Promise<AuthResponse>;
    getTokens(options): Promise<GitHub.TokensResponse>;
    redirectURL(options): string;
}

Methods

authUser getTokens redirectURL

Methods

authUser

  • authUser(options, client_secret?, access_token?): Promise<AuthResponse>

  • Gets user data from GitHub

    Parameters

    • options: GitHub.AuthOptions

      Options that's used when getting user data from GitHub.

    • Optional client_secret: string

      Defaults to undefined, if you don't pass a client_secret API will use Wix Secret Manager to find client_secret named as GitHubClientSecret.

    • Optional access_token: string

      Defaults to undefined, if you don't pass a access_token API will get new one each time.

      -

    Returns Promise<AuthResponse>

getTokens

  • getTokens(options): Promise<GitHub.TokensResponse>

  • Gets tokens for API calls to GitHub. You can refresh expired tokens using refresh tokens.

    +

Returns Promise<AuthResponse>

getTokens

redirectURL

  • redirectURL(options): string

  • Creates a redirect url for authenticating user via GitHub

    +

Returns Promise<GitHub.TokensResponse>

redirectURL

  • redirectURL(options): string

  • Creates a redirect url for authenticating user via GitHub

    Parameters

    Returns string

Settings

Member Visibility

Theme

On This Page

authUsergetTokensredirectURL

Generated using TypeDoc
+

Returns string

Settings

Member Visibility

Theme

On This Page

authUsergetTokensredirectURL

Generated using TypeDoc

Interface google

Read Google Docs for more info about anything here.

-
interface google {
    authUser(options, client_secret?, access_token?): Promise<AuthResponse>;
    getTokens(options): Promise<Google.TokensResponse>;
    redirectURL(options): string;
}

Methods

authUser +
interface google {
    authUser(options, client_secret?, access_token?): Promise<AuthResponse>;
    getTokens(options): Promise<Google.TokensResponse>;
    redirectURL(options): string;
}

Methods

authUser getTokens redirectURL

Methods

authUser

  • authUser(options, client_secret?, access_token?): Promise<AuthResponse>

  • Gets user data from Google

    Parameters

    • options: Google.AuthOptions

      Options that's used when getting user data from Google.

    • Optional client_secret: string

      Defaults to undefined, if you don't pass a client_secret API will use Wix Secret Manager to find client_secret named as GoogleClientSecret.

    • Optional access_token: string

      Defaults to undefined, if you don't pass a access_token API will get new one each time.

      -

    Returns Promise<AuthResponse>

getTokens

  • getTokens(options): Promise<Google.TokensResponse>

  • Gets tokens for API calls to Google. You can refresh expired tokens using refresh tokens.

    +

Returns Promise<AuthResponse>

getTokens

redirectURL

  • redirectURL(options): string

  • Creates a redirect url for authenticating user via Google

    +

Returns Promise<Google.TokensResponse>

redirectURL

  • redirectURL(options): string

  • Creates a redirect url for authenticating user via Google

    Parameters

    Returns string

Settings

Member Visibility

Theme

On This Page

authUsergetTokensredirectURL

Generated using TypeDoc
+

Returns string

Settings

Member Visibility

Theme

On This Page

authUsergetTokensredirectURL

Generated using TypeDoc

Interface steam

Steam itself doesn't provide any OAuth 2.0 or something similar to authenticate users with their APIs. You'll need to implement a secure way to authenticate users via Steam. This isn't a realy OAuth 2.0 method since you won't get any access_token after user sign-in to Steam, what you'll get is users's public Steam ID (number). That you can use to get public info of that user after successful login.

-
interface steam {
    redirectURL(options): string;
    userAuth(options, client_secret?): Promise<AuthResponse>;
}

Methods

redirectURL +
interface steam {
    redirectURL(options): string;
    userAuth(options, client_secret?): Promise<AuthResponse>;
}

Methods

redirectURL userAuth

Methods

redirectURL

  • redirectURL(options): string

  • Creates a redirect url for authenticating user via Steam

    Parameters

    Returns string

userAuth

  • userAuth(options, client_secret?): Promise<AuthResponse>

  • Gets user data from Steam

    +

Returns string

userAuth

  • userAuth(options, client_secret?): Promise<AuthResponse>

  • Gets user data from Steam

    Parameters

    • options: Steam.AuthOptions

      Options that's used when getting user data from Steam.

    • Optional client_secret: string

      Defaults to undefined, if you don't pass a client_secret (apiKey) API will use Wix Secret Manager to find client_secret named as SteamClientSecret.

      -

    Returns Promise<AuthResponse>

Settings

Member Visibility

Theme

On This Page

redirectURLuserAuth

Generated using TypeDoc
+

Returns Promise<AuthResponse>

Settings

Member Visibility

Theme

On This Page

redirectURLuserAuth

Generated using TypeDoc
-

Namespace Discord

Index

Type Aliases

AuthOptions +

Namespace Discord

Index

Type Aliases

AuthOptions RedirectURLOptions TokensOptions TokensResponse

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Namespace Facebook

Index

Type Aliases

AuthOptions +

Namespace Facebook

Index

Type Aliases

AuthOptions RedirectURLOptions TokensOptions TokensResponse

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Namespace GitHub

Index

Type Aliases

AuthOptions +

Namespace GitHub

Index

Type Aliases

AuthOptions RedirectURLOptions TokensOptions TokensResponse

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Namespace Google

Index

Type Aliases

AuthOptions +

Namespace Google

Index

Type Aliases

AuthOptions RedirectURLOptions TokensOptions TokensResponse

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Namespace Steam

Index

Type Aliases

AuthOptions +

Namespace Steam

Index

Type Aliases

AuthOptions RedirectURLOptions

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias AuthResponse

AuthResponse: {
    [key: string]: any;
}

Type declaration

  • [key: string]: any

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias AuthResponse

AuthResponse: {
    [key: string]: any;
}

Type declaration

  • [key: string]: any

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias AuthOptions

AuthOptions: {
    client_id: string;
    code: string;
    grant_type?: string;
    redirect_uri: string;
}

Type declaration

  • client_id: string
  • code: string
  • Optional grant_type?: string
  • redirect_uri: string

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias AuthOptions

AuthOptions: {
    client_id: string;
    code: string;
    grant_type?: string;
    redirect_uri: string;
}

Type declaration

  • client_id: string
  • code: string
  • Optional grant_type?: string
  • redirect_uri: string

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias RedirectURLOptions

RedirectURLOptions: {
    client_id: string;
    prompt?: string;
    redirect_uri: string;
    response_type?: string;
    scope?: string[];
    state?: string;
}

Type declaration

  • client_id: string
  • Optional prompt?: string
  • redirect_uri: string
  • Optional response_type?: string
  • Optional scope?: string[]
  • Optional state?: string

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias RedirectURLOptions

RedirectURLOptions: {
    client_id: string;
    prompt?: string;
    redirect_uri: string;
    response_type?: string;
    scope?: string[];
    state?: string;
}

Type declaration

  • client_id: string
  • Optional prompt?: string
  • redirect_uri: string
  • Optional response_type?: string
  • Optional scope?: string[]
  • Optional state?: string

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias TokensOptions

TokensOptions: {
    client_id: string;
    client_secret: string;
    code?: string;
    grant_type?: string;
    redirect_uri?: string;
    refresh_token?: string;
}

Type declaration

  • client_id: string
  • client_secret: string
  • Optional code?: string
  • Optional grant_type?: string
  • Optional redirect_uri?: string
  • Optional refresh_token?: string

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias TokensOptions

TokensOptions: {
    client_id: string;
    client_secret: string;
    code?: string;
    grant_type?: string;
    redirect_uri?: string;
    refresh_token?: string;
}

Type declaration

  • client_id: string
  • client_secret: string
  • Optional code?: string
  • Optional grant_type?: string
  • Optional redirect_uri?: string
  • Optional refresh_token?: string

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias TokensResponse

TokensResponse: {
    access_token: string;
    expires_in: number;
    refresh_token: string;
    scope: string;
    token_type: string;
}

Type declaration

  • access_token: string
  • expires_in: number
  • refresh_token: string
  • scope: string
  • token_type: string

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias TokensResponse

TokensResponse: {
    access_token: string;
    expires_in: number;
    refresh_token: string;
    scope: string;
    token_type: string;
}

Type declaration

  • access_token: string
  • expires_in: number
  • refresh_token: string
  • scope: string
  • token_type: string

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias AuthOptions

AuthOptions: {
    client_id: string;
    code?: string;
    fields?: string[];
    redirect_uri: string;
}

Type declaration

  • client_id: string
  • Optional code?: string
  • Optional fields?: string[]
  • redirect_uri: string

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias AuthOptions

AuthOptions: {
    client_id: string;
    code?: string;
    fields?: string[];
    redirect_uri: string;
}

Type declaration

  • client_id: string
  • Optional code?: string
  • Optional fields?: string[]
  • redirect_uri: string

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias RedirectURLOptions

RedirectURLOptions: {
    client_id: string;
    redirect_uri: string;
    response_type?: string[];
    scope?: string[];
    state?: string;
}

Type declaration

  • client_id: string
  • redirect_uri: string
  • Optional response_type?: string[]
  • Optional scope?: string[]
  • Optional state?: string

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias RedirectURLOptions

RedirectURLOptions: {
    client_id: string;
    redirect_uri: string;
    response_type?: string[];
    scope?: string[];
    state?: string;
}

Type declaration

  • client_id: string
  • redirect_uri: string
  • Optional response_type?: string[]
  • Optional scope?: string[]
  • Optional state?: string

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias TokensOptions

TokensOptions: {
    client_id: string;
    client_secret: string;
    code?: string;
    fb_exchange_token?: string;
    grant_type?: string;
    redirect_uri?: string;
}

Type declaration

  • client_id: string
  • client_secret: string
  • Optional code?: string
  • Optional fb_exchange_token?: string
  • Optional grant_type?: string
  • Optional redirect_uri?: string

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias TokensOptions

TokensOptions: {
    client_id: string;
    client_secret: string;
    code?: string;
    fb_exchange_token?: string;
    grant_type?: string;
    redirect_uri?: string;
}

Type declaration

  • client_id: string
  • client_secret: string
  • Optional code?: string
  • Optional fb_exchange_token?: string
  • Optional grant_type?: string
  • Optional redirect_uri?: string

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias TokensResponse

TokensResponse: {
    access_token: string;
    expires_in: number;
    token_type: string;
}

Type declaration

  • access_token: string
  • expires_in: number
  • token_type: string

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias TokensResponse

TokensResponse: {
    access_token: string;
    expires_in: number;
    token_type: string;
}

Type declaration

  • access_token: string
  • expires_in: number
  • token_type: string

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias AuthOptions

AuthOptions: {
    client_id: string;
    code: string;
    redirect_uri: string;
    repository_id?: string;
}

Type declaration

  • client_id: string
  • code: string
  • redirect_uri: string
  • Optional repository_id?: string

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias AuthOptions

AuthOptions: {
    client_id: string;
    code: string;
    redirect_uri: string;
    repository_id?: string;
}

Type declaration

  • client_id: string
  • code: string
  • redirect_uri: string
  • Optional repository_id?: string

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias RedirectURLOptions

RedirectURLOptions: {
    allow_signup?: boolean;
    client_id: string;
    redirect_uri: string;
    state?: string;
}

Type declaration

  • Optional allow_signup?: boolean
  • client_id: string
  • redirect_uri: string
  • Optional state?: string

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias RedirectURLOptions

RedirectURLOptions: {
    allow_signup?: boolean;
    client_id: string;
    redirect_uri: string;
    state?: string;
}

Type declaration

  • Optional allow_signup?: boolean
  • client_id: string
  • redirect_uri: string
  • Optional state?: string

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias TokensOptions

TokensOptions: {
    client_id: string;
    client_secret: string;
    code?: string;
    grant_type?: string;
    redirect_uri?: string;
    refresh_token?: string;
    repository_id?: string;
}

Type declaration

  • client_id: string
  • client_secret: string
  • Optional code?: string
  • Optional grant_type?: string
  • Optional redirect_uri?: string
  • Optional refresh_token?: string
  • Optional repository_id?: string

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias TokensOptions

TokensOptions: {
    client_id: string;
    client_secret: string;
    code?: string;
    grant_type?: string;
    redirect_uri?: string;
    refresh_token?: string;
    repository_id?: string;
}

Type declaration

  • client_id: string
  • client_secret: string
  • Optional code?: string
  • Optional grant_type?: string
  • Optional redirect_uri?: string
  • Optional refresh_token?: string
  • Optional repository_id?: string

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias TokensResponse

TokensResponse: {
    access_token: string;
    expires_in: number;
    refresh_token: string;
    refresh_token_expires_in: number;
    scope: string;
    token_type: string;
}

Type declaration

  • access_token: string
  • expires_in: number
  • refresh_token: string
  • refresh_token_expires_in: number
  • scope: string
  • token_type: string

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias TokensResponse

TokensResponse: {
    access_token: string;
    expires_in: number;
    refresh_token: string;
    refresh_token_expires_in: number;
    scope: string;
    token_type: string;
}

Type declaration

  • access_token: string
  • expires_in: number
  • refresh_token: string
  • refresh_token_expires_in: number
  • scope: string
  • token_type: string

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias AuthOptions

AuthOptions: {
    client_id: string;
    code: string;
    grant_type?: string;
    redirect_uri: string;
}

Type declaration

  • client_id: string
  • code: string
  • Optional grant_type?: string
  • redirect_uri: string

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias AuthOptions

AuthOptions: {
    client_id: string;
    code: string;
    grant_type?: string;
    redirect_uri: string;
}

Type declaration

  • client_id: string
  • code: string
  • Optional grant_type?: string
  • redirect_uri: string

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias RedirectURLOptions

RedirectURLOptions: {
    access_type?: string;
    client_id: string;
    prompt?: string;
    redirect_uri: string;
    response_type?: string;
    scope?: string[];
    state?: string;
}

Type declaration

  • Optional access_type?: string
  • client_id: string
  • Optional prompt?: string
  • redirect_uri: string
  • Optional response_type?: string
  • Optional scope?: string[]
  • Optional state?: string

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias RedirectURLOptions

RedirectURLOptions: {
    access_type?: string;
    client_id: string;
    prompt?: string;
    redirect_uri: string;
    response_type?: string;
    scope?: string[];
    state?: string;
}

Type declaration

  • Optional access_type?: string
  • client_id: string
  • Optional prompt?: string
  • redirect_uri: string
  • Optional response_type?: string
  • Optional scope?: string[]
  • Optional state?: string

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias TokensOptions

TokensOptions: {
    client_id: string;
    client_secret?: string;
    code: string;
    grant_type?: string;
    redirect_uri: string;
    refresh_token?: string;
}

Type declaration

  • client_id: string
  • Optional client_secret?: string
  • code: string
  • Optional grant_type?: string
  • redirect_uri: string
  • Optional refresh_token?: string

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias TokensOptions

TokensOptions: {
    client_id: string;
    client_secret?: string;
    code: string;
    grant_type?: string;
    redirect_uri: string;
    refresh_token?: string;
}

Type declaration

  • client_id: string
  • Optional client_secret?: string
  • code: string
  • Optional grant_type?: string
  • redirect_uri: string
  • Optional refresh_token?: string

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias TokensResponse

TokensResponse: {
    access_token: string;
    expires_in: number;
    refresh_token: string;
    scope: string;
    token_type: string;
}

Type declaration

  • access_token: string
  • expires_in: number
  • refresh_token: string
  • scope: string
  • token_type: string

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias TokensResponse

TokensResponse: {
    access_token: string;
    expires_in: number;
    refresh_token: string;
    scope: string;
    token_type: string;
}

Type declaration

  • access_token: string
  • expires_in: number
  • refresh_token: string
  • scope: string
  • token_type: string

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias AuthOptions

AuthOptions: {
    steamId: string;
}

Type declaration

  • steamId: string

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias AuthOptions

AuthOptions: {
    steamId: string;
}

Type declaration

  • steamId: string

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias RedirectURLOptions

RedirectURLOptions: {
    realm: string;
    redirect_uri: string;
    state?: string;
}

Type declaration

  • realm: string
  • redirect_uri: string
  • Optional state?: string

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias RedirectURLOptions

RedirectURLOptions: {
    realm: string;
    redirect_uri: string;
    state?: string;
}

Type declaration

  • realm: string
  • redirect_uri: string
  • Optional state?: string

Settings

Member Visibility

Theme

Generated using TypeDoc