Manifest

Index

Constructors

• constructor

Properties

• bin
• browser
• cpu
• dependencies
• dependenciesMeta
• devDependencies
• errors
• files
• indent
• installConfig
• languageName
• libc
• license
• main
• module
• name
• os
• packageManager
• peerDependencies
• peerDependenciesMeta
• preferUnplugged
• private
• publishConfig
• raw
• resolutions
• scripts
• type
• version
• workspaceDefinitions
• allDependencies
• fileName
• hardDependencies

Methods

• ensureDependencyMeta
• ensurePeerDependencyMeta
• exportTo
• getConditions
• getForScope
• hasConsumerDependency
• hasDependency
• hasHardDependency
• hasSoftDependency
• load
• loadFile
• loadFromText
• setRawField
• find
• fromFile
• fromText
• tryFind

Constructors

constructor

• new Manifest(): Manifest

• Returns Manifest

Properties

publicbin

bin: Map<string, PortablePath> = ...

publicbrowser

browser: null | PortablePath | Map<PortablePath, boolean | PortablePath> = null

publiccpu

cpu: null | string[] = null

publicdependencies

dependencies: Map<IdentHash, Descriptor> = ...

publicdependenciesMeta

dependenciesMeta: Map<string, Map<null | string, DependencyMeta>> = ...

publicdevDependencies

devDependencies: Map<IdentHash, Descriptor> = ...

publicerrors

errors: Error[] = []

errors found in the raw manifest while loading

publicfiles

files: null | Set<PortablePath> = null

publicindent

indent: string = ...

publicinstallConfig

installConfig: null | InstallConfig = null

publiclanguageName

languageName: null | string = null

publiclibc

libc: null | string[] = null

publiclicense

license: null | string = null

publicmain

main: null | PortablePath = null

publicmodule

module: null | PortablePath = null

publicname

name: null | Ident = null

publicos

os: null | string[] = null

publicpackageManager

packageManager: null | string = null

publicpeerDependencies

peerDependencies: Map<IdentHash, Descriptor> = ...

publicpeerDependenciesMeta

peerDependenciesMeta: Map<string, PeerDependencyMeta> = ...

publicpreferUnplugged

preferUnplugged: null | boolean = null

publicprivate

private: boolean = false

publicpublishConfig

publishConfig: null | PublishConfig = null

publicraw

raw: {} = {}

Type declaration

• [key string]: any

publicresolutions

resolutions: { pattern: Resolution; reference: string }[] = []

publicscripts

scripts: Map<string, string> = ...

publictype

type: null | string = null

publicversion

version: null | string = null

publicworkspaceDefinitions

workspaceDefinitions: WorkspaceDefinition[] = []

staticreadonlyallDependencies

allDependencies: AllDependencies[] = ...

staticreadonlyfileName

fileName: Filename = ...

staticreadonlyhardDependencies

hardDependencies: HardDependencies[] = ...

Methods

ensureDependencyMeta

• ensureDependencyMeta(descriptor: Descriptor): DependencyMeta

• Parameters

  • descriptor: Descriptor

  Returns DependencyMeta

ensurePeerDependencyMeta

• ensurePeerDependencyMeta(descriptor: Descriptor): PeerDependencyMeta

• Parameters

  • descriptor: Descriptor

  Returns PeerDependencyMeta

exportTo

• exportTo(data: {}, __namedParameters?: { compatibilityMode?: boolean }): {}

• Parameters

  • data: {}

  • __namedParameters: { compatibilityMode?: boolean } = {}

  • optionalcompatibilityMode: boolean = true

  Returns {}

  • [key string]: any

getConditions

• getConditions(): null | string

• Returns null | string

getForScope

• getForScope(type: string): Map<IdentHash, Descriptor>

• Parameters

  • type: string

  Returns Map<IdentHash, Descriptor>

hasConsumerDependency

• hasConsumerDependency(ident: Ident): boolean

• Parameters

  • ident: Ident

  Returns boolean

hasDependency

• hasDependency(ident: Ident): boolean

• Parameters

  • ident: Ident

  Returns boolean

hasHardDependency

• hasHardDependency(ident: Ident): boolean

• Parameters

  • ident: Ident

  Returns boolean

hasSoftDependency

• hasSoftDependency(ident: Ident): boolean

• Parameters

  • ident: Ident

  Returns boolean

load

• load(data: any, __namedParameters?: { yamlCompatibilityMode?: boolean }): void

• Parameters

  • data: any

  • __namedParameters: { yamlCompatibilityMode?: boolean } = {}

  • optionalyamlCompatibilityMode: boolean = false

  Returns void

loadFile

• loadFile(path: PortablePath, __namedParameters: { baseFs?: FakeFS<PortablePath> }): Promise<void>

• Parameters

  • path: PortablePath

  • __namedParameters: { baseFs?: FakeFS<PortablePath> }

  • optionalbaseFs: FakeFS<PortablePath> = ...

  Returns Promise<void>

loadFromText

• loadFromText(text: string): void

• Parameters

  • text: string

  Returns void

setRawField

• setRawField(name: string, value: any, __namedParameters?: { after?: string[] }): void

• Parameters

  • name: string

  • value: any

  • __namedParameters: { after?: string[] } = {}

  • optionalafter: string[] = []

  Returns void

staticfind

• find(path: PortablePath, __namedParameters?: { baseFs?: FakeFS<PortablePath> }): Promise<Manifest>

• Parameters

  • path: PortablePath

  • __namedParameters: { baseFs?: FakeFS<PortablePath> } = {}

  • optionalbaseFs: FakeFS<PortablePath>

  Returns Promise<Manifest>

staticfromFile

• fromFile(path: PortablePath, __namedParameters?: { baseFs?: FakeFS<PortablePath> }): Promise<Manifest>

• Parameters

  • path: PortablePath

  • __namedParameters: { baseFs?: FakeFS<PortablePath> } = {}

  • optionalbaseFs: FakeFS<PortablePath> = ...

  Returns Promise<Manifest>

staticfromText

• fromText(text: string): Manifest

• Parameters

  • text: string

  Returns Manifest

statictryFind

• tryFind(path: PortablePath, __namedParameters?: { baseFs?: FakeFS<PortablePath> }): Promise<null | Manifest>

• Parameters

  • path: PortablePath

  • __namedParameters: { baseFs?: FakeFS<PortablePath> } = {}

  • optionalbaseFs: FakeFS<PortablePath> = ...

  Returns Promise<null | Manifest>