Class UserConfiguration

A configuration. Defines settings and setting groups.

Hierarchy (view full)

Constructors

Properties

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>;
        signSectionArchive: Setting<boolean, boolean>;
        signingBehavior: Setting<EnumValue<typeof ContributionSurveyRowSigningBehavior>, ContributionSurveyRowSigningBehavior>;
        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>;
        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>;
} = ...
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>;
    signSectionArchive: Setting<boolean, boolean>;
    signingBehavior: Setting<EnumValue<typeof ContributionSurveyRowSigningBehavior>, ContributionSurveyRowSigningBehavior>;
    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>;
    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>
  • 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>;
} = ...
type: "user" = ...
configVersion: 1 = 1
optionKey: "userjs-deputy" = 'userjs-deputy'

Methods

  • 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.