molefrog / srcset-parse

🏙 Extra tiny `srcset` attribute parser ~150B

srcset-parse

An extra small srcset attribute parser compliant with the latest spec. It's is inspired by the srcset package and has following features:

• Extra tiny, only ~150B;
• Supports URLs that contain commas;
• Zero or one descriptors per image definitions are supported (like 2x or 100w, but not both!);

Example usage:

import parse from "srcset-parse";

/**
 * [
 *   { url: "hifi-cat.jpeg",  density: 3 },
 *   { url: "lowfi-cat.jpeg", width: 128 },
 * ]
 */
parse("hifi-cat.jpeg 3x, lowfi-cat.jpeg 128w");

Using with TypeScript

The library is written in TypeScript, so you can import types if needed:

import parse, { ImageCandidate } from "srcset-parse";

const result: ImageCandidate[] = parse("[email protected] 2x, icon.png 1x");

Platform support

This library is written according to the ES2015 standard. Make sure your platform supports it, or your project is configured to transpile external modules.

srcset-parse's Issues

srcset with no space after the comma

I'm trying to understand if this is the correct behavior - when there is no space after the comma the parsing fails.
The following will fail with 'Invalid srcset descriptor':

srcset.parse("banner-HD.jpg 2x,banner-phone.jpg 100w");

Due to the regular expression in the code: string.split(/,\s+/)

Changing to string.split(/,\s*/)

Will fix the problem.

Is that on purpose?