Typedef

Static Public Summary
public	AuthConfig: Object
public	AuthProfile: Object
public	ButtonColor: Object
public	ButtonStyle: Object
public	CodeEditorThemeType: Object Type of theme
public	EnumEndpoint: Object
public	EnvKey: Object An env key.
public	FSModalColor: Object Colors of the modal
public	FollowType: Object
public	FollowedType: Object
public	HTTPMethod: Object
public	Key: Object A global key (not env related).
public	NotificationCategory: Object
public	NotificationMarkAllUnseen: Symbol Pass to mark all notifications
public	NotificationStatus: number See Notification.getStatuses
public	NotificationType: number See Notification.getTypes
public	ScrollProperty: Object
public	SearchInputResults: Object
public	TemplateType: Object
public	TextInputType: Object
public	ValidationError: Object
public	Validator: Object

Static Public

public AuthConfig: Object source

Properties:

Name	Type	Attribute	Description
append	boolean	optional default: false	If logged in, append to current user.

public AuthProfile: Object source

Properties:

Name	Type	Attribute	Description
email	string
name	string
avatar	string	nullable: true

public ButtonColor: Object source

Properties:

Name	Type	Attribute	Description
green	Object		Green background
accent	Object		Accent colored background
blue	Object		Blue background
plain	Object		No special coloring just blue text
accentBorder	Object		Accent border and foreground
blackOnWhite	Object		white button
highContrast	Object		always maintains max contrast
minimalGreen	Object		green version of high contrast.
red	Object		red version of high contrast.
activeBlue	Object		non-transitioning theme color
activeAxtell	Object		non-transitioning theme color of axtell

public ButtonStyle: Object source

Properties:

Name	Type	Attribute	Description
normal	Object		Normal default style
plain	Object		A small caps amd smaller style
minimal	Object		Modern style w/ border and slight bevel effect

public CodeEditorThemeType: Object source

Type of theme

public EnumEndpoint: Object source

Properties:

Name	Type	Attribute	Description
notificationType	string		The types of a notification
notificationStatus	string		The types of a notification

public EnvKey: Object source

An env key. These are constant over a server's instance

Properties:

Name	Type	Attribute	Description
algoliaAppId	string		app id for algolia
algoliaSearchKey	string		search key for algolia
csrf	string		CSRF token
isDebug	string		If is debugging instance
host	string		canonical host
webAPNId	string		The web.id of webapns
minUsernameLength	string		minimum username length
maxUsernameLength	string		maximum username length

public FSModalColor: Object source

Colors of the modal

Properties:

Name	Type	Attribute	Description
default	string		Default color

public FollowType: Object source

Properties:

Name	Type	Attribute	Description
followers	Object
following	Object

public FollowedType: Object source

Properties:

Name	Type	Attribute	Description
following	Object
followers	Object

public HTTPMethod: Object source

Properties:

Name	Type	Attribute	Description
GET	string
PET	string
POST	string
DELETE	string

public Key: Object source

A global key (not env related).

Properties:

Name	Type	Attribute	Description
helpCenter	string		Object for help center page data.
settingsContext	string		If is user settings screen
userEmail	string		The email of the user
loginData	string		OAuth datas ONLY available when not logged in.
userReceiveNotifications	string		If user wants notifications

public NotificationCategory: Object source

Properties:

Name	Type	Attribute	Description
status	string
answer	string
postComment	string
answerComment	string

public NotificationMarkAllUnseen: Symbol source

Pass to mark all notifications

public NotificationStatus: number source

See Notification.getStatuses

public NotificationType: number source

See Notification.getTypes

public ScrollProperty: Object source

Properties:

Name	Type	Attribute	Description
margin	string		Use for block elements
absolute	string		Use for absolute positioned elements

public SearchInputResults: Object source

Properties:

Name	Type	Attribute	Description
results	T[]		The results
areMore	boolean		if more results

public TemplateType: Object source

public TextInputType: Object source

Properties:

Name	Type	Attribute	Description
Search	string		for search bars
Title	string		for challenge titles
Email	string		for emails
Name	string		for names.
URL	string		for URLs

public ValidationError: Object source

Properties:

Name	Type	Attribute	Description
node	HTMLElement		Node with error.
error	string		String describing error
sourceValidator	Validator		The 'validator' object.

public Validator: Object source

Properties:

Name	Type	Attribute	Description
callback	Function		Runs validator given element.
error	string		String to display on error.