Quark v1.2.0 Documentation

quark/pkg

quark/pkg #

getOrigin(from) #

http://google.com/aa/test.txt => http://google.com
zip:///home/xxx/test.apk@/assets/bb.jpg => zip:///home/xxx/test.apk@
file:///d:/a/bc/d/e/f/test.txt => file://d:
file:///a/bc/d/e/f/test.txt => file://

@param from: string
@return string

Interface: PackageJson #

PackageJson #

packagejson.name #

name: string

packagejson.main #

main: string

packagejson.version #

version: string

packagejson.description? #

description?: string

packagejson.scripts? #

scripts?: Dict<string>

packagejson.author? #

author?: Dict<string>

packagejson.keywords? #

keywords?: string[]

packagejson.license? #

license?: string

packagejson.bugs? #

bugs?: Dict<string>

packagejson.homepage? #

homepage?: string

packagejson.devDependencies? #

devDependencies?: Dict<string>

packagejson.dependencies? #

dependencies?: Dict<string>

packagejson.bin? #

bin?: string

packagejson.hash? #

hash?: string

packagejson.pkgzHash? #

pkgzHash?: string

packagejson.id? #

id?: string

packagejson.app? #

app?: string

packagejson.tryLocal? #

tryLocal?: boolean

packagejson.symlink? #

symlink?: string package path symlink

packagejson.pkgzSize? #

pkgzSize?: number pkgz file size

packagejson.modules? #

modules?: Dict<Dict<PackageJson>>

packagejson.load(noCache?) #

load packages name and version and files hash

@param noCache?: boolean

packagejson.loadSync() #

async load packages name and version and files hash

Class: Module #

Module #

@implements IModule

module.id #

@get id: string

module.exports #

@get exports: any

module.parent #

@get parent: Module|null

module.package #

@get package: Package|null

module.filename #

@get filename: string filename

module.dirname #

@get dirname: string dirname

module.loaded #

@get loaded: boolean

module.children #

@get children: Module[]

module.paths #

@get paths: string[] search paths

module.require(path) #

Request module by the path

@param path: string
@return any

Class: Package #

Package #

package.json #

package json information

@get json: PackageJson

package.name #

package name

@get name: string

package.tryLocal #

Did you attempt to use a local reference package when an error
occurred while downloading and installing the network package

@get tryLocal: boolean

package.path #

package path, zip:///applications/test.apk@, qk://quark, file:///node_modules/xxxx

@get path: string

package.hash #

package hash

@get hash: string

package.pkgzHash #

pkgz hash

@get pkgzHash: string

package.filesHash #

version information of files in the package

@get filesHash: Dict<string>

package.build #

is build

@get build: boolean

package.isHttp #

is http path

@get isHttp: boolean

package.isInternal #

is internal package

@get isInternal: boolean

package.resolve(relativePath) #

Lookup internal module by the relative path

@param relativePath: string
@return any

package.install() #

Async install package

@return Promise<void>

package.installSync() #

Sync install package

Class: QkPackage #

QkPackage #

qk://quark ExtendModule Internal expansion module

@extends Package

default #

default.mainPackage #

@get mainPackage: Package

default.mainModule #

@get mainModule: Module

default.mainFilename #

@get mainFilename: string

default.addSearchPath(path,isFirst?,noCache?) #

Add global search path

@param path: string global search directory path
@param isFirst?: boolean use high priority
@param noCache?: boolean use __no_cache param load pkgs.json file
@return Promise<void>

default.lookupPackage(name,parent?) #

Lookup package by package name

@param name: string
@param parent?: Module
@return Package|null

Quark #

Modules #

Table of Contents