Class UserConfiguration

A configuration. Defines settings and setting groups.

Hierarchy (view full)

ConfigurationBase
- UserConfiguration

Index

Constructors

`Protected`constructor

new UserConfiguration(serializedData?): UserConfiguration
Creates a new Configuration.
Parameters
- serializedData: any = {}
Returns UserConfiguration
Overrides ConfigurationBase.constructor
- Defined in src/config/UserConfiguration.ts:270

Properties

`Readonly`all

all: {
    ante: {
        enableAutoMerge: Setting<boolean, boolean>;
        onSubmit: Setting<EnumValue<typeof CompletionAction>, CompletionAction>;
    };
    cci: {
        autoCollapseRows: Setting<boolean, boolean>;
        autoShowDiff: Setting<boolean, boolean>;
        enablePageToolbar: Setting<boolean, boolean>;
        forceUtc: Setting<boolean, boolean>;
        maxRevisionsToAutoShowDiff: Setting<number, number>;
        maxSizeToAutoShowDiff: Setting<number, number>;
        openOldOnContinue: Setting<boolean, boolean>;
        showCvLink: Setting<boolean, boolean>;
        showUsername: Setting<boolean, boolean>;
        signingBehavior: Setting<EnumValue<typeof ContributionSurveyRowSigningBehavior>, ContributionSurveyRowSigningBehavior>;
        signSectionArchive: Setting<boolean, boolean>;
        toolbarInitialState: Setting<EnumValue<typeof DeputyPageToolbarState>, DeputyPageToolbarState>;
    };
    core: {
        configVersion: Setting<number, number>;
        dangerMode: Setting<boolean, boolean>;
        language: Setting<string, string>;
        modules: Setting<string[], string[]>;
        portletNames: Setting<EnumValue<typeof PortletNameView>, PortletNameView>;
        resetDatabase: Action;
        resetPreferences: Action;
        seenAnnouncements: Setting<string[], string[]>;
    };
    ia: {
        defaultEntirePage: Setting<boolean, boolean>;
        defaultFromUrls: Setting<boolean, boolean>;
        enablePageToolbar: Setting<boolean, boolean>;
        onBatchSubmit: Setting<EnumValue<typeof CompletionAction>, CompletionAction>;
        onHide: Setting<EnumValue<typeof TripleCompletionAction>, TripleCompletionAction>;
        onSubmit: Setting<EnumValue<typeof TripleCompletionAction>, TripleCompletionAction>;
        responses: Setting<CopyrightProblemsResponseSet, CopyrightProblemsResponseSet>;
    };
} = ...

Type declaration

ante: {
enableAutoMerge: Setting<boolean, boolean>;
onSubmit: Setting<EnumValue<typeof CompletionAction>, CompletionAction>;
}
- ReadonlyenableAutoMerge: Setting<boolean, boolean>
- ReadonlyonSubmit: Setting<EnumValue<typeof CompletionAction>, CompletionAction>
cci: {
    autoCollapseRows: Setting<boolean, boolean>;
    autoShowDiff: Setting<boolean, boolean>;
    enablePageToolbar: Setting<boolean, boolean>;
    forceUtc: Setting<boolean, boolean>;
    maxRevisionsToAutoShowDiff: Setting<number, number>;
    maxSizeToAutoShowDiff: Setting<number, number>;
    openOldOnContinue: Setting<boolean, boolean>;
    showCvLink: Setting<boolean, boolean>;
    showUsername: Setting<boolean, boolean>;
    signingBehavior: Setting<EnumValue<typeof ContributionSurveyRowSigningBehavior>, ContributionSurveyRowSigningBehavior>;
    signSectionArchive: Setting<boolean, boolean>;
    toolbarInitialState: Setting<EnumValue<typeof DeputyPageToolbarState>, DeputyPageToolbarState>;
}
- ReadonlyautoCollapseRows: Setting<boolean, boolean>
- ReadonlyautoShowDiff: Setting<boolean, boolean>
- ReadonlyenablePageToolbar: Setting<boolean, boolean>
- ReadonlyforceUtc: Setting<boolean, boolean>
- ReadonlymaxRevisionsToAutoShowDiff: Setting<number, number>
- ReadonlymaxSizeToAutoShowDiff: Setting<number, number>
- ReadonlyopenOldOnContinue: Setting<boolean, boolean>
- ReadonlyshowCvLink: Setting<boolean, boolean>
- ReadonlyshowUsername: Setting<boolean, boolean>
- ReadonlysigningBehavior: Setting<EnumValue<typeof ContributionSurveyRowSigningBehavior>, ContributionSurveyRowSigningBehavior>
- ReadonlysignSectionArchive: Setting<boolean, boolean>
- ReadonlytoolbarInitialState: Setting<EnumValue<typeof DeputyPageToolbarState>, DeputyPageToolbarState>
core: {
    configVersion: Setting<number, number>;
    dangerMode: Setting<boolean, boolean>;
    language: Setting<string, string>;
    modules: Setting<string[], string[]>;
    portletNames: Setting<EnumValue<typeof PortletNameView>, PortletNameView>;
    resetDatabase: Action;
    resetPreferences: Action;
    seenAnnouncements: Setting<string[], string[]>;
}
- ReadonlyconfigVersion: Setting<number, number>
  Numerical code that identifies this config version. Increments for every breaking configuration file change.
- ReadonlydangerMode: Setting<boolean, boolean>
- Readonlylanguage: Setting<string, string>
- Readonlymodules: Setting<string[], string[]>
- ReadonlyportletNames: Setting<EnumValue<typeof PortletNameView>, PortletNameView>
- ReadonlyresetDatabase: Action
- ReadonlyresetPreferences: Action
- ReadonlyseenAnnouncements: Setting<string[], string[]>
ia: {
    defaultEntirePage: Setting<boolean, boolean>;
    defaultFromUrls: Setting<boolean, boolean>;
    enablePageToolbar: Setting<boolean, boolean>;
    onBatchSubmit: Setting<EnumValue<typeof CompletionAction>, CompletionAction>;
    onHide: Setting<EnumValue<typeof TripleCompletionAction>, TripleCompletionAction>;
    onSubmit: Setting<EnumValue<typeof TripleCompletionAction>, TripleCompletionAction>;
    responses: Setting<CopyrightProblemsResponseSet, CopyrightProblemsResponseSet>;
}
- ReadonlydefaultEntirePage: Setting<boolean, boolean>
- ReadonlydefaultFromUrls: Setting<boolean, boolean>
- ReadonlyenablePageToolbar: Setting<boolean, boolean>
- ReadonlyonBatchSubmit: Setting<EnumValue<typeof CompletionAction>, CompletionAction>
- ReadonlyonHide: Setting<EnumValue<typeof TripleCompletionAction>, TripleCompletionAction>
- ReadonlyonSubmit: Setting<EnumValue<typeof TripleCompletionAction>, TripleCompletionAction>
- Readonlyresponses: Setting<CopyrightProblemsResponseSet, CopyrightProblemsResponseSet>

`Readonly`ante

ante: {
enableAutoMerge: Setting<boolean, boolean>;
onSubmit: Setting<EnumValue<typeof CompletionAction>, CompletionAction>;
} = ...

`Readonly`cci

cci: {
    autoCollapseRows: Setting<boolean, boolean>;
    autoShowDiff: Setting<boolean, boolean>;
    enablePageToolbar: Setting<boolean, boolean>;
    forceUtc: Setting<boolean, boolean>;
    maxRevisionsToAutoShowDiff: Setting<number, number>;
    maxSizeToAutoShowDiff: Setting<number, number>;
    openOldOnContinue: Setting<boolean, boolean>;
    showCvLink: Setting<boolean, boolean>;
    showUsername: Setting<boolean, boolean>;
    signingBehavior: Setting<EnumValue<typeof ContributionSurveyRowSigningBehavior>, ContributionSurveyRowSigningBehavior>;
    signSectionArchive: Setting<boolean, boolean>;
    toolbarInitialState: Setting<EnumValue<typeof DeputyPageToolbarState>, DeputyPageToolbarState>;
} = ...

`Readonly`core

core: {
    configVersion: Setting<number, number>;
    dangerMode: Setting<boolean, boolean>;
    language: Setting<string, string>;
    modules: Setting<string[], string[]>;
    portletNames: Setting<EnumValue<typeof PortletNameView>, PortletNameView>;
    resetDatabase: Action;
    resetPreferences: Action;
    seenAnnouncements: Setting<string[], string[]>;
} = ...

Type declaration

ReadonlyconfigVersion: Setting<number, number>
Numerical code that identifies this config version. Increments for every breaking configuration file change.
ReadonlydangerMode: Setting<boolean, boolean>
Readonlylanguage: Setting<string, string>
Readonlymodules: Setting<string[], string[]>
ReadonlyportletNames: Setting<EnumValue<typeof PortletNameView>, PortletNameView>
ReadonlyresetDatabase: Action
ReadonlyresetPreferences: Action
ReadonlyseenAnnouncements: Setting<string[], string[]>

`Readonly`ia

ia: {
    defaultEntirePage: Setting<boolean, boolean>;
    defaultFromUrls: Setting<boolean, boolean>;
    enablePageToolbar: Setting<boolean, boolean>;
    onBatchSubmit: Setting<EnumValue<typeof CompletionAction>, CompletionAction>;
    onHide: Setting<EnumValue<typeof TripleCompletionAction>, TripleCompletionAction>;
    onSubmit: Setting<EnumValue<typeof TripleCompletionAction>, TripleCompletionAction>;
    responses: Setting<CopyrightProblemsResponseSet, CopyrightProblemsResponseSet>;
} = ...

`Readonly`type

type: "user" = ...

`Static` `Readonly`configVersion

configVersion = 1

`Static` `Readonly`optionKey

optionKey: "userjs-deputy" = 'userjs-deputy'

Methods

deserialize

deserialize(serializedData): void
Deserializes a JSON configuration into this configuration. This WILL overwrite past settings.
Parameters
- serializedData: any
Returns void
Inherited from ConfigurationBase.deserialize
- Defined in src/config/ConfigurationBase.ts:37

save

save(): Promise<void>
Saves the configuration.

Returns Promise<void>
Overrides ConfigurationBase.save
- Defined in src/config/UserConfiguration.ts:295

serialize

serialize(): any
Returns any
the serialized version of the configuration. All undefined values are stripped from output. If a category remains unchanged from defaults, it is skipped. If the entire configuration remains unchanged, null is returned.
Inherited from ConfigurationBase.serialize
- Defined in src/config/ConfigurationBase.ts:58

`Static`load

load(): UserConfiguration
Returns UserConfiguration
the configuration from the current wiki.
Overrides ConfigurationBase.load
- Defined in src/config/UserConfiguration.ts:32

Class UserConfiguration

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

Protectedconstructor

Parameters

Returns UserConfiguration

Properties

Readonlyall

Type declaration

ante: { enableAutoMerge: Setting<boolean, boolean>; onSubmit: Setting<EnumValue<typeof CompletionAction>, CompletionAction>; }

ReadonlyenableAutoMerge: Setting<boolean, boolean>

ReadonlyonSubmit: Setting<EnumValue<typeof CompletionAction>, CompletionAction>

ReadonlyautoCollapseRows: Setting<boolean, boolean>

ReadonlyautoShowDiff: Setting<boolean, boolean>

ReadonlyenablePageToolbar: Setting<boolean, boolean>

ReadonlyforceUtc: Setting<boolean, boolean>

ReadonlymaxRevisionsToAutoShowDiff: Setting<number, number>

ReadonlymaxSizeToAutoShowDiff: Setting<number, number>

ReadonlyopenOldOnContinue: Setting<boolean, boolean>

ReadonlyshowCvLink: Setting<boolean, boolean>

ReadonlyshowUsername: Setting<boolean, boolean>

ReadonlysigningBehavior: Setting<EnumValue<typeof ContributionSurveyRowSigningBehavior>, ContributionSurveyRowSigningBehavior>

ReadonlysignSectionArchive: Setting<boolean, boolean>

ReadonlytoolbarInitialState: Setting<EnumValue<typeof DeputyPageToolbarState>, DeputyPageToolbarState>

ReadonlyconfigVersion: Setting<number, number>

ReadonlydangerMode: Setting<boolean, boolean>

Readonlylanguage: Setting<string, string>

Readonlymodules: Setting<string[], string[]>

ReadonlyportletNames: Setting<EnumValue<typeof PortletNameView>, PortletNameView>

ReadonlyresetDatabase: Action

ReadonlyresetPreferences: Action

ReadonlyseenAnnouncements: Setting<string[], string[]>

ReadonlydefaultEntirePage: Setting<boolean, boolean>

ReadonlydefaultFromUrls: Setting<boolean, boolean>

ReadonlyenablePageToolbar: Setting<boolean, boolean>

ReadonlyonBatchSubmit: Setting<EnumValue<typeof CompletionAction>, CompletionAction>

ReadonlyonHide: Setting<EnumValue<typeof TripleCompletionAction>, TripleCompletionAction>

ReadonlyonSubmit: Setting<EnumValue<typeof TripleCompletionAction>, TripleCompletionAction>

Readonlyresponses: Setting<CopyrightProblemsResponseSet, CopyrightProblemsResponseSet>

Readonlyante

Readonlycci

Readonlycore

Type declaration

ReadonlyconfigVersion: Setting<number, number>

ReadonlydangerMode: Setting<boolean, boolean>

Readonlylanguage: Setting<string, string>

Readonlymodules: Setting<string[], string[]>

ReadonlyportletNames: Setting<EnumValue<typeof PortletNameView>, PortletNameView>

ReadonlyresetDatabase: Action

ReadonlyresetPreferences: Action

ReadonlyseenAnnouncements: Setting<string[], string[]>

Readonlyia

Readonlytype

Static ReadonlyconfigVersion

Static ReadonlyoptionKey

Methods

deserialize

Parameters

Returns void

save

Returns Promise<void>

serialize

Returns any

Staticload

Returns UserConfiguration

Settings

On This Page

`Protected`constructor

`Readonly`all

ante: {
enableAutoMerge: Setting<boolean, boolean>;
onSubmit: Setting<EnumValue<typeof CompletionAction>, CompletionAction>;
}

`Readonly`enableAutoMerge: Setting<boolean, boolean>

`Readonly`onSubmit: Setting<EnumValue<typeof CompletionAction>, CompletionAction>

`Readonly`autoCollapseRows: Setting<boolean, boolean>

`Readonly`autoShowDiff: Setting<boolean, boolean>

`Readonly`enablePageToolbar: Setting<boolean, boolean>

`Readonly`forceUtc: Setting<boolean, boolean>

`Readonly`maxRevisionsToAutoShowDiff: Setting<number, number>

`Readonly`maxSizeToAutoShowDiff: Setting<number, number>

`Readonly`openOldOnContinue: Setting<boolean, boolean>

`Readonly`showCvLink: Setting<boolean, boolean>

`Readonly`showUsername: Setting<boolean, boolean>

`Readonly`signingBehavior: Setting<EnumValue<typeof ContributionSurveyRowSigningBehavior>, ContributionSurveyRowSigningBehavior>

`Readonly`signSectionArchive: Setting<boolean, boolean>

`Readonly`toolbarInitialState: Setting<EnumValue<typeof DeputyPageToolbarState>, DeputyPageToolbarState>

`Readonly`configVersion: Setting<number, number>

`Readonly`dangerMode: Setting<boolean, boolean>

`Readonly`language: Setting<string, string>

`Readonly`modules: Setting<string[], string[]>

`Readonly`portletNames: Setting<EnumValue<typeof PortletNameView>, PortletNameView>

`Readonly`resetDatabase: Action

`Readonly`resetPreferences: Action

`Readonly`seenAnnouncements: Setting<string[], string[]>

`Readonly`defaultEntirePage: Setting<boolean, boolean>

`Readonly`defaultFromUrls: Setting<boolean, boolean>

`Readonly`enablePageToolbar: Setting<boolean, boolean>

`Readonly`onBatchSubmit: Setting<EnumValue<typeof CompletionAction>, CompletionAction>

`Readonly`onHide: Setting<EnumValue<typeof TripleCompletionAction>, TripleCompletionAction>

`Readonly`onSubmit: Setting<EnumValue<typeof TripleCompletionAction>, TripleCompletionAction>

`Readonly`responses: Setting<CopyrightProblemsResponseSet, CopyrightProblemsResponseSet>

`Readonly`ante

`Readonly`cci

`Readonly`core

`Readonly`configVersion: Setting<number, number>

`Readonly`dangerMode: Setting<boolean, boolean>

`Readonly`language: Setting<string, string>

`Readonly`modules: Setting<string[], string[]>

`Readonly`portletNames: Setting<EnumValue<typeof PortletNameView>, PortletNameView>

`Readonly`resetDatabase: Action

`Readonly`resetPreferences: Action

`Readonly`seenAnnouncements: Setting<string[], string[]>

`Readonly`ia

`Readonly`type

`Static` `Readonly`configVersion

`Static` `Readonly`optionKey

`Static`load