All files / src/browser index.ts

100% Statements 3/3
100% Branches 0/0
100% Functions 1/1
100% Lines 3/3

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 191x                             1x 4x    
import { bRando, Options } from "../bRando";
 
/**
 * A function for creating a background changer ({@link bRando} instance) in the web browser environment. It accepts an {@link Options} object. A usage example can be found in [the readme](https://github.com/isaacyakl/brandojs#-usage).
 *
 * ### Demo
 * Create a demo instance for testing or verifying correct installation by omitting the {@link Options} parameter.
 * ```javascript
 * const demo = bRando.create(); // Selects the <body> element by default
 * ```
 * @remarks
 * [[include:first-background.md]]
 * [[include:transition-duration-timeout-warning.md]]
 *
 */
export function create(options?: Options): bRando {
	return new bRando(options);
}