Type alias HuzmaCliConfig<Permissions>

HuzmaCliConfig<Permissions>: {
    authors?: {
        email?: string;
        name: string;
        url?: string;
    }[];
    buildDir?: string;
    description?: string;
    disablePackageJsonFill?: boolean;
    entry?: string;
    files?: string[];
    homepageUrl?: string;
    ignore?: string[];
    invalidation?: InvalidationStrategy;
    keywords?: string[];
    license?: string;
    logoUrl?: string;
    metadata?: Record<string, string>;
    name?: string;
    outFile?: string;
    packageJsonPath?: string;
    permissions?: PermissionsListOptions<Permissions>;
    repo?: {
        type: string;
        url: string;
    };
    version?: string;
}

A configuration file for Huzma cli commands

Type Parameters

Type declaration

  • Optional authors?: {
        email?: string;
        name: string;
        url?: string;
    }[]
  • Optional buildDir?: string

    Path to package files.

  • Optional description?: string
  • Optional disablePackageJsonFill?: boolean
  • Optional entry?: string
  • Optional files?: string[]
  • Optional homepageUrl?: string
  • Optional ignore?: string[]

    An array of files, directories, globs, or regexes to not include in the generated Huzma manifest's "files" key.

  • Optional invalidation?: InvalidationStrategy
  • Optional keywords?: string[]
  • Optional license?: string
  • Optional logoUrl?: string
  • Optional metadata?: Record<string, string>
  • Optional name?: string
  • Optional outFile?: string

    Path where generated Huzma Manifest shoul be written

  • Optional packageJsonPath?: string

    Path of package.json to fill values from

  • Optional permissions?: PermissionsListOptions<Permissions>
  • Optional repo?: {
        type: string;
        url: string;
    }
    • type: string
    • url: string
  • Optional version?: string

Generated using TypeDoc