Skip to main content

BaseInternetAccount

Auto-generated from the config schema in the source — see the config guide for concepts. Built into JBrowse core. View source.

Holds an internet account's name and description, the domains it handles, and the request header it sends credentials in. Every internet account type has these slots.

Overview

BaseInternetAccount - Identifier

Every BaseInternetAccount has a unique internetAccountId, a required top-level field that identifies it (not one of the config slots below).

Config slots

BaseInternetAccount is a shared base schema, not a type you name in a config. Set these slots on one of the configs under Extended by above, each of which lists them as inherited and shows the shape in an example. Slot types (fileLocation, frozen, ...) are explained in the config slot types reference. Slots a base configuration contributes are listed here too, so this table is the whole surface.

SlotDescription
name
string = ''		descriptive name of the internet account
description
string = ''		a description of the internet account
authHeader
string = 'Authorization'		request header for credentials
tokenType
string = ''		a custom name for a token to include in the header
domains
stringArray = []		array of valid domains the url can contain to use this account