@aedart/vuepress-utils
Version:
A few utilities for Vuepress.
36 lines (32 loc) • 940 B
TypeScript
/**
* @aedart/vuepress-utils
*
* BSD-3-Clause, Copyright (c) 2023-present Alin Eugen Deac <aedart@gmail.com>.
*/
import { Plugin } from '@vuepress/core';
import { DateTimeJSOptions } from 'luxon/src/datetime';
/**
* Last Updated Plugin Options
*/
interface lastUpdatedPluginOptions {
/**
* Datetime format
*
* @see https://moment.github.io/luxon/#/formatting?id=table-of-tokens
*/
format?: string;
/**
* Datetime Options
*/
options?: DateTimeJSOptions;
}
/**
* Formats the last updated timestamp according to given format
*
* @param {string | undefined} [format='yyyy-MM-dd HH:mm:ss ZZZZ']
* @param {import('luxon/src/datetime').DateTimeJSOptions | undefined} [options={}]
*
* @returns {import('@vuepress/core').Plugin}
*/
declare const lastUpdatedPlugin: ({ format, options }?: lastUpdatedPluginOptions) => Plugin;
export { lastUpdatedPlugin, type lastUpdatedPluginOptions };