Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AppConfig

Configuration data for the current app.

On browser platforms, creating an instance of this class without any arguments will use window.location.origin as the app domain. On non-browser platforms, you need to specify an app domain as the second argument.

Hierarchy

  • AppConfig

Index

Constructors

Properties

Methods

Constructors

constructor

  • new AppConfig(scopes?: string[], appDomain?: string | undefined, redirectPath?: string, manifestPath?: string, coreNode?: string | undefined, authenticatorURL?: string): AppConfig

  • Parameters

    • Default value scopes: string[] = DEFAULT_SCOPE.slice()

      permissions this app is requesting

    • Default value appDomain: string | undefined = getGlobalObject('location', { returnEmptyObject: true })?.origin

      the app domain

    • Default value redirectPath: string = ""

      path on app domain to redirect users to after authentication

    • Default value manifestPath: string = "/manifest.json"

      path relative to app domain of app's manifest file

    • Default value coreNode: string | undefined = undefined

      override the default or user selected core node

    • Default value authenticatorURL: string = DEFAULT_BLOCKSTACK_HOST

      the web-based fall back authenticator (DEFAULT_BLOCKSTACK_HOST)

    Returns AppConfig

Properties

Optional appDomain

appDomain: undefined | string

Blockstack apps are uniquely identified by their app domain.

Optional authenticatorURL

authenticatorURL: undefined | string

The URL of a web-based Blockstack Authenticator to use in the event the user doesn't have Blockstack installed on their machine. If this is not specified, the current default in this library will be used.

Optional coreNode

coreNode: undefined | string

The URL of Blockstack core node to use for this app. If this is null, the core node specified by the user or default core node will be used.

manifestPath

manifestPath: string

Path relative to app domain of app's manifest file.

This file needs to have CORS headers set so that it can be fetched from any origin. Typically this means return the header Access-Control-Allow-Origin: *.

redirectPath

redirectPath: string

Path on app domain to redirect users to after authentication. The authentication response token will be postpended in a query.

scopes

scopes: (AuthScope | string)[]

An array of string representing permissions requested by the app.

Methods

manifestURI

  • manifestURI(): string

redirectURI

  • redirectURI(): string

Generated using TypeDoc