document what the node api & cli return #91

axe312ger · 2019-06-20T11:37:43Z

node

{
  svg: '<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 300 188">...</svg>',
  metadata: {
    originalWidth: 1024,
    originalHeight: 640,
    palette: {
      // https://github.com/akfish/node-vibrant#vibrantswatch
      Vibrant: [Swatch],
      DarkVibrant: [Swatch],
      LightVibrant: [Swatch],
      Muted: [Swatch],
      DarkMuted: [Swatch],
      LightMuted: [Swatch]
    },
    width: 300,
    height: 188,
    type: 'svg',
    dataURI: "data:image/svg+xml,...",
    dataURIBase64: 'data:image/svg+xml;base64,...'
  }
}

CLI

Fully featured

$ sqip -i __tests__/fixtures/beach.jpg
Processing: __tests__/fixtures/beach.jpg
[Preview image (iTerm2 users only)]
┌───────────────┬────────────────┬───────┬────────┬──────┐
│ originalWidth │ originalHeight │ width │ height │ type │
├───────────────┼────────────────┼───────┼────────┼──────┤
│ 1024          │ 640            │ 300   │ 188    │ svg  │
└───────────────┴────────────────┴───────┴────────┴──────┘
┌─────────┬─────────────┬──────────────┬─────────┬───────────┬────────────┐
│ Vibrant │ DarkVibrant │ LightVibrant │ Muted   │ DarkMuted │ LightMuted │
├─────────┼─────────────┼──────────────┼─────────┼───────────┼────────────┤
│ #dd852f │ #be4e0c     │ #f2b17a      │ #5c8fa4 │ #694e35   │ #cfc8b7    │
└─────────┴─────────────┴──────────────┴─────────┴───────────┴────────────┘

non-TTY & --parseable-output input flag

$ sqip -i __tests__/fixtures/beach.jpg --parseable-output
Processing: __tests__/fixtures/beach.jpg
originalWidth originalHeight width height type
1024          640            300   188    svg
Vibrant DarkVibrant LightVibrant Muted   DarkMuted LightMuted
#dd852f #be4e0c     #f2b17a      #5c8fa4 #694e35   #cfc8b7

--silent flag

$ sqip -i __tests__/fixtures/beach.jpg --silent

axe312ger added the documentation label Jun 20, 2019

axe312ger added this to the 1.0.0 milestone Jun 20, 2019

axe312ger changed the title ~~document what the node api returns~~ document what the node api & cli return Jun 20, 2019

axe312ger closed this in 15d3bf2 Dec 26, 2019

Aug	SEP	Oct
	17
2019	2020	2021

axe312ger / sqip

document what the node api & cli return #91

document what the node api & cli return #91

axe312ger commented Jun 20, 2019 •

edited

axe312ger / sqip

Join GitHub today

document what the node api & cli return #91

document what the node api & cli return #91

Comments

axe312ger commented Jun 20, 2019 • edited

node

CLI

axe312ger commented Jun 20, 2019 •

edited