Logo for jsDocs.io

is-svg

  • Version 6.1.0
  • Published
  • 3.73 kB
  • 1 dependency
  • MIT license

Install

npm i is-svg
yarn add is-svg
pnpm add is-svg

Overview

Check if a string is SVG

Index

Functions

Type Aliases

Functions

function isSvg

isSvg: (string: string, options?: Options) => boolean;

  • Check if a string is [SVG](https://en.wikipedia.org/wiki/Scalable_Vector_Graphics).

    Example 1

    import isSvg from 'is-svg';
    

    isSvg('<svg xmlns="http://www.w3.org/2000/svg"><path fill="#00CD9F"/></svg>');
    //=> true

Type Aliases

type Options

type Options = {
    /**
	Whether to validate the SVG as proper XML.


	Turning this off can improve performance significantly.


	@default true
	*/
    validate?: boolean;
};

    Package Files (1)

    Dependencies (1)

    Dev Dependencies (5)

    Peer Dependencies (0)

    No peer dependencies.

    Badge

    To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

    You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/is-svg.

    • Markdown
      [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/is-svg)
    • HTML
      <a href="https://www.jsdocs.io/package/is-svg"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>