Skip to content 

IPackage Interface

Packages > @fluidframework/container-definitions > IPackage

Typescript interface definition for fields within a npm module’s package.json.

Signature:

export interface IPackage 

Properties

List of properties of this interface
Property Type Description
author IPerson
bin { [key: string]: string; }
browser string
bugs { url: string; email: string; }
bundledDependencies { [key: string]: string; }
config { [key: string]: string; }
contributors IPerson[]
cpu string[]
dependencies { [key: string]: string; }
description string
devDependencies { [key: string]: string; }
engines { node: string; npm: string; }
files string[]
homepage string
keywords string[]
license string
main string
man string | string[]
name string
optionalDependencies { [key: string]: string; }
os string[]
peerDependencies { [key: string]: string; }
private boolean
repository string | { type: string; url: string; }
scripts { [key: string]: string; }
version string

Events

author

Signature:

author?: IPerson;

bin

Signature:

bin?: {
        [key: string]: string;
    };

browser

Signature:

browser?: string;

bugs

Signature:

bugs?: {
        url: string;
        email: string;
    };

bundledDependencies

Signature:

bundledDependencies?: {
        [key: string]: string;
    };

config

Signature:

config?: {
        [key: string]: string;
    };

contributors

Signature:

contributors?: IPerson[];

cpu

Signature:

cpu?: string[];

dependencies

Signature:

dependencies?: {
        [key: string]: string;
    };

description

Signature:

description?: string;

devDependencies

Signature:

devDependencies?: {
        [key: string]: string;
    };

engines

Signature:

engines?: {
        node: string;
        npm: string;
    };

files

Signature:

files?: string[];

homepage

Signature:

homepage?: string;

keywords

Signature:

keywords?: string[];

license

Signature:

license?: string;

main

Signature:

main?: string;

man

Signature:

man?: string | string[];

name

Signature:

name: string;

optionalDependencies

Signature:

optionalDependencies?: {
        [key: string]: string;
    };

os

Signature:

os?: string[];

peerDependencies

Signature:

peerDependencies?: {
        [key: string]: string;
    };

private

Signature:

private?: boolean;

repository

Signature:

repository?: string | {
        type: string;
        url: string;
    };

scripts

Signature:

scripts?: {
        [key: string]: string;
    };

version

Signature:

version: string;