@bb-cli/lib-find-backbase-items

Find backbase catalog items on the file system

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
@bb-cli/lib-find-backbase-items
Minified + gzip package size for @bb-cli/lib-find-backbase-items in KB

Readme

Modules

@bb-cli/lib-find-backbase-items

Finds CXP Items And Builds Sources

Functions

itemFiles()Array.<string>
mergeItems()

Takes any number of arrays of CXP items and merges them all into a single array of CXP items.

@bb-cli/lib-find-backbase-items

Finds CXP Items And Builds Sources

@bb-cli/lib-find-backbase-items.findUnbuiltAndPrebuiltItems(unbuiltPaths, prebuiltPaths, exclude) ⇒ Promise.<FoundItems>

Find unbuilt items, and prebuilt items.

Kind: static method of @bb-cli/lib-find-backbase-items
Returns: Promise.<FoundItems> - Array of items found

Param Type Description
unbuiltPaths Array.<string> Paths to unbuilt sources
prebuiltPaths Array.<string> Array of paths to pre-built sources
exclude Array.<string> Array of paths to exclude from packaging

Example

import { findUnbuiltAndPrebuiltItems } from '@bb-cli/lib-find-backbase-items';
findAndBuild(['.'], ['node_modules'], ['target'])
  .then(({ unbuiltItems, prebuiltItems }) =>
    console.log(`${unbuiltItems.length} items to build`));

@bb-cli/lib-find-backbase-items~CXPItem : Object

An object that describes a catalog item in CXP Manager.

Kind: inner typedef of @bb-cli/lib-find-backbase-items
Properties

Name Type Description
name string The CXP item name.
type string The CXP item type.
version string The CXP item version.
srcDir string The path to the item's source on the file system.
distDir string The path to the built code on the file system, if it was built.
files Array.<string> The files for this item

@bb-cli/lib-find-backbase-items~FoundItems : Object

An object that describes found CXP items.

Kind: inner typedef of @bb-cli/lib-find-backbase-items
Properties

Name Type
unbuiltItems Array.<CXPItem>
prebuiltItems Array.<CXPItem>

itemFiles() ⇒ Array.<string>

Kind: global function
Returns: Array.<string> - The files for this item

mergeItems() ⇒

Takes any number of arrays of CXP items and merges them all into a single array of CXP items.

Kind: global function
Returns: Array.

Type
Array.<CXPItem>

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.