@duplicis/types - v1.0.0
    Preparing search index...

    Interface PackageJSON

    interface PackageJSON {
        author?: Person;
        ava?: AVAConfigSchema;
        bin?: string | { [k: string]: string | undefined };
        bugs?: string | { email?: string; url?: string; [k: string]: unknown };
        bundledDependencies?: boolean | string[];
        bundleDependencies?: boolean | string[];
        config?: { [k: string]: unknown };
        contributors?: Person1[];
        cpu?: string[];
        dependencies?: Dependency;
        description?: string;
        devDependencies?: Dependency;
        directories?: {
            bin?: string;
            doc?: string;
            example?: string;
            lib?: string;
            man?: string;
            test?: string;
            [k: string]: unknown;
        };
        dist?: { shasum?: string; tarball?: string; [k: string]: unknown };
        engines?:
            | { node?: string; [k: string]: string
            | undefined }
            | { duplicis?: string };
        engineStrict?: boolean;
        eslintConfig?: JSONSchemaForESLintConfigurationFiles;
        esnext?:
            | string
            | { browser?: string; main?: string; [k: string]: string
            | undefined };
        exports?:
            | string
            | {
                "."?: PackageExportsEntry
                | PackageExportsFallback;
                [k: string]: PackageExportsEntry | PackageExportsFallback | undefined;
            }
            | PackageExportsEntryObject1
            | PackageExportsFallback1
            | null;
        files?: string[];
        funding?: | string
        | FundingWay
        | [string | FundingWay, ...(string | FundingWay)[]];
        homepage?: string;
        i18n?: Record<string, string>;
        importmap?: Record<string, string>;
        jscpd?: HttpsJsonSchemastoreOrgJscpdJson;
        jspm?: JSONSchemaForNPMPackageJsonFiles1;
        keywords?: string[];
        license?: string;
        licenses?: { type?: string; url?: string; [k: string]: unknown }[];
        main?: string;
        maintainers?: Person1[];
        man?: string | string[];
        module?: string;
        name: string;
        optionalDependencies?: Dependency;
        os?: string[];
        overrides?: { [k: string]: unknown };
        packageManager?: string;
        peerDependencies?: Dependency;
        peerDependenciesMeta?: {
            [k: string]: { optional?: boolean; [k: string]: unknown } | undefined;
        };
        preferGlobal?: boolean;
        prettier?: SchemaForPrettierrc;
        private?: boolean
        | "false"
        | "true";
        publishConfig?: {
            access?: "public" | "restricted";
            registry?: string;
            tag?: string;
            [k: string]: unknown;
        };
        readme?: string;
        release?: SemanticReleaseSchema;
        repository?: | string
        | { directory?: string; type?: string; url?: string; [k: string]: unknown };
        resolutions?: { [k: string]: unknown };
        scripts?: {
            install?: string;
            lint?: string;
            postinstall?: string;
            postpack?: string;
            postpublish?: string;
            postrestart?: string;
            poststart?: string;
            poststop?: string;
            posttest?: string;
            postuninstall?: string;
            postversion?: string;
            preinstall?: string;
            prepack?: string;
            prepare?: string;
            prepublish?: string;
            prepublishOnly?: string;
            prerestart?: string;
            prestart?: string;
            prestop?: string;
            pretest?: string;
            preuninstall?: string;
            preversion?: string;
            publish?: string;
            restart?: string;
            serve?: string;
            start?: string;
            stop?: string;
            test?: string;
            uninstall?: string;
            version?: string;
            [k: string]: string | undefined;
        };
        stylelint?: JSONSchemaForTheStylelintConfigurationFiles;
        type?: "commonjs"
        | "module";
        types?: string;
        typesVersions?: { [k: string]: { "*"?: string[] } | undefined };
        typings?: string;
        version: string;
        workspaces?:
            | string[]
            | { nohoist?: string[]; packages?: string[]; [k: string]: unknown };
        [key: string]: any;
    }

    Hierarchy

    • JSONSchemaForNPMPackageJsonFiles
      • PackageJSON

    Indexable

    • [key: string]: any
    Index

    Properties

    author? ava? bin? bugs? bundledDependencies? bundleDependencies? config? contributors? cpu? dependencies? description? devDependencies? directories? dist? engines? engineStrict? eslintConfig? esnext? exports? files? funding? homepage? i18n? importmap? jscpd? jspm? keywords? license? licenses? main? maintainers? man? module? name optionalDependencies? os? overrides? packageManager? peerDependencies? peerDependenciesMeta? preferGlobal? prettier? private? publishConfig? readme? release? repository? resolutions? scripts? stylelint? type? types? typesVersions? typings? version workspaces?

    Properties

    author?: Person
    ava?: AVAConfigSchema
    bin?: string | { [k: string]: string | undefined }
    bugs?: string | { email?: string; url?: string; [k: string]: unknown }

    The url to your project's issue tracker and / or the email address to which issues should be reported. These are helpful for people who encounter issues with your package.

    Type Declaration

    • string
    • { email?: string; url?: string; [k: string]: unknown }
      • [k: string]: unknown
      • Optionalemail?: string

        The email address to which issues should be reported.

      • Optionalurl?: string

        The url to your project's issue tracker.

    bundledDependencies?: boolean | string[]

    Array of package names that will be bundled when publishing the package.

    bundleDependencies?: boolean | string[]

    DEPRECATED: This field is honored, but "bundledDependencies" is the correct field name.

    config?: { [k: string]: unknown }

    A 'config' hash can be used to set configuration parameters used in package scripts that persist across upgrades.

    contributors?: Person1[]

    A list of people who contributed to this package.

    cpu?: string[]

    Specify that your code only runs on certain cpu architectures.

    dependencies?: Dependency
    description?: string

    This helps people discover your package, as it's listed in 'npm search'.

    devDependencies?: Dependency
    directories?: {
        bin?: string;
        doc?: string;
        example?: string;
        lib?: string;
        man?: string;
        test?: string;
        [k: string]: unknown;
    }

    Type Declaration

    • [k: string]: unknown
    • Optionalbin?: string

      If you specify a 'bin' directory, then all the files in that folder will be used as the 'bin' hash.

    • Optionaldoc?: string

      Put markdown files in here. Eventually, these will be displayed nicely, maybe, someday.

    • Optionalexample?: string

      Put example scripts in here. Someday, it might be exposed in some clever way.

    • Optionallib?: string

      Tell people where the bulk of your library is. Nothing special is done with the lib folder in any way, but it's useful meta info.

    • Optionalman?: string

      A folder that is full of man pages. Sugar to generate a 'man' array by walking the folder.

    • Optionaltest?: string
    dist?: { shasum?: string; tarball?: string; [k: string]: unknown }
    engines?:
        | { node?: string; [k: string]: string
        | undefined }
        | { duplicis?: string }
    engineStrict?: boolean
    eslintConfig?: JSONSchemaForESLintConfigurationFiles
    esnext?:
        | string
        | { browser?: string; main?: string; [k: string]: string
        | undefined }

    A module ID with untranspiled code that is the primary entry point to your program.

    exports?:
        | string
        | {
            "."?: PackageExportsEntry
            | PackageExportsFallback;
            [k: string]: PackageExportsEntry | PackageExportsFallback | undefined;
        }
        | PackageExportsEntryObject1
        | PackageExportsFallback1
        | null

    The "exports" field is used to restrict external access to non-exported module files, also enables a module to import itself using "name".

    Type Declaration

    • string
    • {
          "."?: PackageExportsEntry | PackageExportsFallback;
          [k: string]: PackageExportsEntry | PackageExportsFallback | undefined;
      }
      • [k: string]: PackageExportsEntry | PackageExportsFallback | undefined

        The module path prefix that is resolved when the module specifier starts with "name/", set to "./*" to allow external modules to import any subpath.

        This interface was referenced by undefined's JSON-Schema definition via the patternProperty "^./.+".

      • Optional.?: PackageExportsEntry | PackageExportsFallback

        The module path that is resolved when the module specifier matches "name", shadows the "main" field.

    • PackageExportsEntryObject1
    • PackageExportsFallback1
    • null
    files?: string[]

    The 'files' field is an array of files to include in your project. If you name a folder in the array, then it will also include the files inside that folder.

    funding?:
        | string
        | FundingWay
        | [string | FundingWay, ...(string | FundingWay)[]]
    homepage?: string

    The url to the project homepage.

    i18n?: Record<string, string>
    importmap?: Record<string, string>
    jscpd?: HttpsJsonSchemastoreOrgJscpdJson
    jspm?: JSONSchemaForNPMPackageJsonFiles1
    keywords?: string[]

    This helps people discover your package as it's listed in 'npm search'.

    license?: string

    You should specify a license for your package so that people know how they are permitted to use it, and any restrictions you're placing on it.

    licenses?: { type?: string; url?: string; [k: string]: unknown }[]

    DEPRECATED: Instead, use SPDX expressions, like this: { "license": "ISC" } or { "license": "(MIT OR Apache-2.0)" } see: 'https://docs.npmjs.com/files/package.json#license'.

    main?: string

    The main field is a module ID that is the primary entry point to your program.

    maintainers?: Person1[]

    A list of people who maintains this package.

    man?: string | string[]

    Specify either a single file or an array of filenames to put in place for the man program to find.

    module?: string

    An ECMAScript module ID that is the primary entry point to your program.

    name: string

    The name of the package.

    optionalDependencies?: Dependency
    os?: string[]

    Specify which operating systems your module will run on.

    overrides?: { [k: string]: unknown }

    Overrides is used to support selective version overrides using npm, which lets you define custom package versions or ranges inside your dependencies. For yarn, use resolutions instead. See: https://docs.npmjs.com/cli/v9/configuring-npm/package-json#overrides

    packageManager?: string

    Defines which package manager is expected to be used when working on the current project. This field is currently experimental and needs to be opted-in; see https://nodejs.org/api/corepack.html

    peerDependencies?: Dependency
    peerDependenciesMeta?: {
        [k: string]: { optional?: boolean; [k: string]: unknown } | undefined;
    }

    When a user installs your package, warnings are emitted if packages specified in "peerDependencies" are not already installed. The "peerDependenciesMeta" field serves to provide more information on how your peer dependencies are utilized. Most commonly, it allows peer dependencies to be marked as optional. Metadata for this field is specified with a simple hash of the package name to a metadata object.

    preferGlobal?: boolean

    DEPRECATED: This option used to trigger an npm warning, but it will no longer warn. It is purely there for informational purposes. It is now recommended that you install any binaries as local devDependencies wherever possible.

    prettier?: SchemaForPrettierrc
    private?: boolean | "false" | "true"

    If set to true, then npm will refuse to publish it.

    publishConfig?: {
        access?: "public" | "restricted";
        registry?: string;
        tag?: string;
        [k: string]: unknown;
    }
    readme?: string
    release?: SemanticReleaseSchema
    repository?:
        | string
        | { directory?: string; type?: string; url?: string; [k: string]: unknown }

    Specify the place where your code lives. This is helpful for people who want to contribute.

    resolutions?: { [k: string]: unknown }

    Resolutions is used to support selective version resolutions using yarn, which lets you define custom package versions or ranges inside your dependencies. For npm, use overrides instead. See: https://classic.yarnpkg.com/en/docs/selective-version-resolutions

    scripts?: {
        install?: string;
        lint?: string;
        postinstall?: string;
        postpack?: string;
        postpublish?: string;
        postrestart?: string;
        poststart?: string;
        poststop?: string;
        posttest?: string;
        postuninstall?: string;
        postversion?: string;
        preinstall?: string;
        prepack?: string;
        prepare?: string;
        prepublish?: string;
        prepublishOnly?: string;
        prerestart?: string;
        prestart?: string;
        prestop?: string;
        pretest?: string;
        preuninstall?: string;
        preversion?: string;
        publish?: string;
        restart?: string;
        serve?: string;
        start?: string;
        stop?: string;
        test?: string;
        uninstall?: string;
        version?: string;
        [k: string]: string | undefined;
    }

    The 'scripts' member is an object hash of script commands that are run at various times in the lifecycle of your package. The key is the lifecycle event, and the value is the command to run at that point.

    Type Declaration

    • [k: string]: string | undefined
    • Optionalinstall?: string
    • Optionallint?: string

      Run code quality tools, e.g. ESLint, TSLint, etc.

    • Optionalpostinstall?: string
    • Optionalpostpack?: string

      Run AFTER the tarball has been generated and moved to its final destination.

    • Optionalpostpublish?: string
    • Optionalpostrestart?: string
    • Optionalpoststart?: string
    • Optionalpoststop?: string
    • Optionalposttest?: string
    • Optionalpostuninstall?: string

      Run AFTER the package is uninstalled.

    • Optionalpostversion?: string

      Run AFTER bump the package version.

    • Optionalpreinstall?: string

      Run BEFORE the package is installed.

    • Optionalprepack?: string

      run BEFORE a tarball is packed (on npm pack, npm publish, and when installing git dependencies).

    • Optionalprepare?: string

      Run both BEFORE the package is packed and published, and on local npm install without any arguments. This is run AFTER prepublish, but BEFORE prepublishOnly.

    • Optionalprepublish?: string

      Run BEFORE the package is published (Also run on local npm install without any arguments).

    • OptionalprepublishOnly?: string

      Run BEFORE the package is prepared and packed, ONLY on npm publish.

    • Optionalprerestart?: string
    • Optionalprestart?: string
    • Optionalprestop?: string
    • Optionalpretest?: string
    • Optionalpreuninstall?: string
    • Optionalpreversion?: string
    • Optionalpublish?: string

      Publishes a package to the registry so that it can be installed by name. See https://docs.npmjs.com/cli/v8/commands/npm-publish

    • Optionalrestart?: string
    • Optionalserve?: string

      Start dev server to serve application files

    • Optionalstart?: string
    • Optionalstop?: string
    • Optionaltest?: string
    • Optionaluninstall?: string
    • Optionalversion?: string
    stylelint?: JSONSchemaForTheStylelintConfigurationFiles
    type?: "commonjs" | "module"

    When set to "module", the type field allows a package to specify all .js files within are ES modules. If the "type" field is omitted or set to "commonjs", all .js files are treated as CommonJS.

    types?: string

    Set the types property to point to your bundled declaration file.

    typesVersions?: { [k: string]: { "*"?: string[] } | undefined }

    The "typesVersions" field is used since TypeScript 3.1 to support features that were only made available in newer TypeScript versions.

    Type Declaration

    • [k: string]: { "*"?: string[] } | undefined

      Contains overrides for the TypeScript version that matches the version range matching the property key.

      Type Declaration

      • { "*"?: string[] }
        • Optional*?: string[]

          Maps all file paths to the file paths specified in the array.

      • undefined
    typings?: string

    Note that the "typings" field is synonymous with "types", and could be used as well.

    version: string

    Version must be parseable by node-semver, which is bundled with npm as a dependency.

    workspaces?:
        | string[]
        | { nohoist?: string[]; packages?: string[]; [k: string]: unknown }

    Allows packages within a directory to depend on one another using direct linking of local files. Additionally, dependencies within a workspace are hoisted to the workspace root when possible to reduce duplication. Note: It's also a good idea to set "private" to true when using this feature.

    Type Declaration

    • string[]
    • { nohoist?: string[]; packages?: string[]; [k: string]: unknown }
      • [k: string]: unknown
      • Optionalnohoist?: string[]

        Packages to block from hoisting to the workspace root. Currently only supported in Yarn only.

      • Optionalpackages?: string[]

        Workspace package paths. Glob patterns are supported.

    Settings

    Member Visibility

    On This Page

    Properties