Package Exports
- @roots/bud-api
- @roots/bud-api/api
- @roots/bud-api/methods
- @roots/bud-api/methods/alias/handleCallback
- @roots/bud-api/methods/alias/handleFallthrough
- @roots/bud-api/methods/alias/handleRecords
- @roots/bud-api/methods/alias/handleSignifierValuePair
- @roots/bud-api/methods/alias/index
- @roots/bud-api/methods/alias/isCallback
- @roots/bud-api/methods/alias/isRecords
- @roots/bud-api/methods/alias/isSignifierValuePair
- @roots/bud-api/methods/alias/schema
- @roots/bud-api/methods/alias/types
- @roots/bud-api/methods/assets/index
- @roots/bud-api/methods/bundle/index
- @roots/bud-api/methods/config/index
- @roots/bud-api/methods/define/index
- @roots/bud-api/methods/devtool/index
- @roots/bud-api/methods/entry/guards
- @roots/bud-api/methods/entry/handleNamed
- @roots/bud-api/methods/entry/handleNormalRecord
- @roots/bud-api/methods/entry/handlePrimitive
- @roots/bud-api/methods/entry/handleSimpleRecord
- @roots/bud-api/methods/entry/index
- @roots/bud-api/methods/entry/normalize
- @roots/bud-api/methods/entry/schema
- @roots/bud-api/methods/entry/types
- @roots/bud-api/methods/experiments/index
- @roots/bud-api/methods/externals/index
- @roots/bud-api/methods/hash/index
- @roots/bud-api/methods/html/helpers
- @roots/bud-api/methods/html/index
- @roots/bud-api/methods/index
- @roots/bud-api/methods/minimize/index
- @roots/bud-api/methods/persist/index
- @roots/bud-api/methods/provide/index
- @roots/bud-api/methods/proxy/helpers
- @roots/bud-api/methods/proxy/index
- @roots/bud-api/methods/proxy/proxy.method
- @roots/bud-api/methods/proxy/proxy.types
- @roots/bud-api/methods/runtime/index
- @roots/bud-api/methods/serve/childError
- @roots/bud-api/methods/serve/index
- @roots/bud-api/methods/serve/serve.types
- @roots/bud-api/methods/splitChunks/index
- @roots/bud-api/methods/use/index
- @roots/bud-api/methods/watch/index
Readme
@roots/bud-api
bud.js core module
Installation
Install @roots/bud-api to your project.
Yarn:
yarn add @roots/bud-api --devnpm:
npm install @roots/bud-api --save-devAPI
For full documentation refer to bud.js.org/docs.
bud.entry
bud.entry is used to specify and group assets to include in the compilation.
If no entrypoint is provided bud.js will attempt to compile src/index.js to dist/main.js.
bud.html
bud.html is used to configure your application's HTML wrapper.
bud.provide
bud.provide makes a variable or module available throughout the entire application.
bud.proxy
bud.proxy is a method that configures a proxy server for your development environment. This is useful when you need to proxy requests to a backend server, such as a WordPress site.
bud.serve
bud.serve is used to configure the development server.
You don't need to call this function unless you want to change the default server configuration.
bud.watch
bud.watch is used to specify files which will trigger a full browser reload when changed.
Contributing
Contributions are welcome from everyone.
We have contribution guidelines to help you get started.
License
@roots/bud-api is licensed under MIT.
Community
Keep track of development and community news.
- Join us on Roots Slack by becoming a GitHub sponsor
- Participate on the Roots Discourse
- Follow @rootswp on Twitter
- Read and subscribe to the Roots Blog
- Subscribe to the Roots Newsletter
Sponsors
Help support our open-source development efforts by becoming a patron.
