Interface RevealApi

js/reveal.d.ts:52–788

	 * @see {@link https://github.com/hakimel/reveal.js/blob/master/js/reveal.js}
	 */
	export interface RevealApi {
		/**
		 * The reveal.js version
		 *
		 * @returns reveal.js version
		 */
		VERSION: string;

		/**
		 * Starts up the presentation.
		 *
		 * @param options - RevealOption see {@link Options}
		 * @returns a promise
		 */
		initialize(options?: RevealConfig): Promise<RevealApi>;

		/**
		 * Applies the configuration settings from the config
		 * object. May be called multiple times.
		 *
		 * @param options - RevealOption see {@link RevealConfig}
		 */
		configure(options?: RevealConfig): void;

		/**
		 * Uninitializes reveal.js by undoing changes made to the
		 * DOM and removing all event listeners.
		 */
		destroy(): void;

		/**
		 * Syncs the presentation with the current DOM. Useful
		 * when new slides or control elements are added or when
		 * the configuration has changed.
		 */
		sync(): void;

		/**
		 * Updates reveal.js to keep in sync with new slide attributes. For
		 * example, if you add a new `data-background-image` you can call
		 * this to have reveal.js render the new background image.
		 *
		 * Similar to #sync() but more efficient when you only need to
		 * refresh a specific slide. Dispatches a `slidesync` event
		 * when syncing has completed.
		 *
		 * @param  slide
		 * @see {@link sync}
		 */
		syncSlide(slide: HTMLElement): void;

		/**
		 * Formats the fragments on the given slide so that they have
		 * valid indices. Call this if fragments are changed in the DOM
		 * after reveal.js has already initialized.
		 *
		 * @param slide
		 * @returns a list of the HTML fragments that were synced