mkdocs-material/typings/svgo/index.d.ts

69 lines
1.9 KiB
TypeScript

/*
* Copyright (c) 2016-2022 Martin Donath <martin.donath@squidfunk.com>
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to
* deal in the Software without restriction, including without limitation the
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
* sell copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
* IN THE SOFTWARE.
*/
/* ----------------------------------------------------------------------------
* Types
* ------------------------------------------------------------------------- */
declare module "svgo" {
/**
* Plugin
*/
interface Plugin {
name: string
active: boolean
}
/**
* Optimization configuration
*/
interface OptimizeConfig {
plugins: Plugin[]
}
/**
* Optimization result
*/
interface OptimizeResult {
data: string
}
/**
* Optimize SVG
*
* @param data - SVG data
*
* @returns Optimization result
*/
function optimize(data: string, config: OptimizeConfig): OptimizeResult
/**
* Extend the list of default plugins
*
* @param plugins - Plugins
*
* @returns Plugins
*/
function extendDefaultPlugins(plugins: Plugin[]): Plugin[]
}