UNPKG

990 BTypeScriptView Raw
1import { ConfigFile } from './configFile';
2type UserConfig = {
3 usernames: string[];
4};
5/**
6 * A config file that stores usernames for an org.
7 */
8export declare class OrgUsersConfig extends ConfigFile<OrgUsersConfig.Options, UserConfig> {
9 /**
10 * Constructor.
11 * **Do not directly construct instances of this class -- use {@link OrgUsersConfig.create} instead.**
12 *
13 * @param options The options for the class instance
14 * @ignore
15 */
16 constructor(options?: OrgUsersConfig.Options);
17 /**
18 * Gets the config options for a given org ID.
19 *
20 * @param orgId The orgId. Generally this org would have multiple users configured.
21 */
22 static getOptions(orgId: string): OrgUsersConfig.Options;
23}
24export declare namespace OrgUsersConfig {
25 /**
26 * The config file options.
27 */
28 type Options = {
29 /**
30 * The org id associated with this user.
31 */
32 orgId: string;
33 } & ConfigFile.Options;
34}
35export {};