🌐 api

• * required
• ? optional
• ⛓ chainable and returns the instance
• 🗯 arguments - if applicable
• 📘 example
• 🔙 return value
• configs instance of DLL with configs to export

🗝️

• dir
• config
• find
• pkgDeps
• lastModifiedFilter
• debug
• toConfig
• staleTime
• everyX
• og
• cacheBustingFiles
• context
• shouldBeUsed
• clearCache
• auto (static)
• configs (static)

dir

❗ currently, for non-static functions, this has to be the first function called. likely this will be improved with a minor refactor.

?⛓ directory to resolve paths to

🗯 arguments

• ?directory
  • type: string
  • default: process.cwd()

📘 example

configs.dir(__dirname)

config

*⛓ webpack config

🗯 arguments

• config
  • type: object webpack config object

📘 example

const config = {
  context: './src',
  entry: { index: 'index.js' },
  output: { path: 'output', filename: '[name].js' }
}

const configs = DLL.config(config)

find

?⛓ find files in src code, use them if they haven't been edited recently

🗯 arguments

• ?glob
  • type: string glob
  • default: src/**/*.+(js|jsx|ts|tsx)

📘 example

default

configs.find()

custom

configs.find(`src/**/*.+(js|jsx|ts|tsx)`)

pkgDeps

?⛓ loads dependencies, and optionally devDependencies from package.json

🗯 arguments

• ?filterFn(Array<?dependency: string>, Array<?devDependencies: string>, Array<?allDependencies: string>)
  • type: function
  • default: null

📘 example

default package.dependencies

configs.pkgDeps()

with filter callback

configs
  .pkgDeps((deps, dev, all) => {
    if (process.env.NODE_ENV === 'production') {
      return deps
    }
    return all.filter(dep => !['fliplog'].includes(dep))
  })

lastModifiedFilter

?⛓ last modified specification filter for including files that don't change often when using .find

🗯 arguments

• type: object fliptime#tillNowSatisfies

📘 example

more on time specification obj

would filter .find to include files that were last edited at least 1 day ago

configs.lastModifiedFilter({days: 1})

debug

?⛓ enables or disables debugging logs

uses fliplog

🗯 arguments

• ?should
  • type: boolean

📘 example

configs.debug(true)

toConfig

* returns an array of webpack configs, your application config(s), alongside dll config(s) when needed

🔙 returns

Array<Object> webpack configs

📘 example

module.exports = configs.toConfig()

---

staleTime

? after a certain number of time since the last DLL build, build it again to keep it fresh

🗯 arguments

• object
  • type: object fliptime#tillNowSatisfies
  • default: {days: 1}

📘 example

more on time specification obj

configs.everyX(100)

everyX

? every X number of builds, rebuild the dll, clears the cache to keep it light

🗯 arguments

• number
  • type: number
  • default: 33

📘 example

configs.everyX(100)

og

when needed (e.g. testing time difference), for ease-of-use, this will return the original (og) config in .toConfig() regardless of the other settings

🗯 arguments

• number
  • type: number
  • default: 33

📘 example

configs.everyX(100)

cacheBustingFiles

? an array of absolute file paths that bust the cache when changed using flipcache

🗯 arguments

• files
  • type: array
  • default: [require.main.filename, resolve(dir, package.json)]

📘 example

const {resolve} = require('path')
const res = rel => resolve(__dirname, rel)

const files = [res('./src/vendor.js'), res('./.babelrc')]
configs.cacheBustingFiles(files)

---

auto (static)

?⛓ use all defaults, configure config & dir, call other required functions automatically

🗯 arguments

• config
  • type: object
• dir

🔙 returns

Array<Object> webpack configs

📘 example

const configs = DLL.auto(config, __dirname)

is the same as using the default values by calling each method manually

const auto = new DLL()
const configs = auto
  .dir(__dirname)
  .config(config)
  .find()
  .pkgDeps()
  .toConfig()

configs (static)

for an array of configs

🗯 arguments

• configs
  • type: array
• cb called for each config, same usage as the api
  • type: function

🔙 returns

Array<Object> webpack configs (flattens the return array configs, since each config becomes an array itself to contain dll config when needed)

📘 see config for example on array of configs

---

context

?⛓ context property for DLLPlugin

🗯 arguments

• type: string path?? (docs do not seem to cover this)

Webpack DLLPlugin source Webpack DllReferencePlugin source

shouldBeUsed

?⛓ override whether to use dll plugin or not, force using or not

🗯 arguments

• type: boolean

📘 example

const configs = dll.dir(__dirname).config(config).shouldBeUsed(true).toConfig()

clearCache

?⛓ delete the cache files

📘 example

dll.clearCache()

---

time-specifications

check that the difference is equal or greater than specification.

(use only 1 property, all are integers)

• longhand: {seconds, hours, minutes, days, years}
• shorthand: {s, h, m, d, y}

// true: was >= 60 seconds ago
tillNowSatisfies(Date.now() - 60000, {seconds: 60})