https://shields.io/assets/js/23e87e45.bc82fed6.js

1"use strict";(self.webpackChunkshields_io=self.webpackChunkshields_io||[]).push([[16500],{69193(e,i,s){s.r(i),s.d(i,{contentTitle:()=>t,default:()=>c,frontMatter:()=>r,metadata:()=>n,toc:()=>o});const n=JSON.parse('{"type":"api","id":"npm-package-minimized-gzipped-size","title":"npm package minimized gzipped size","description":"","slug":"/npm-package-minimized-gzipped-size","frontMatter":{},"api":{"description":"\\nView <a href=\\"https://github.com/evanw/esbuild\\" target=\\"_blank\\" rel=\\"noopener\\">esbuild</a> minified and <a href=\\"https://github.com/hazae41/denoflate\\" target=\\"_blank\\" rel=\\"noopener\\">denoflate</a> gzipped size of a javascript package or selected exports, via <a href=\\"https://bundlejs.com/\\" target=\\"_blank\\" rel=\\"noopener\\">bundlejs</a>.\\n","parameters":[{"name":"packageName","in":"path","required":true,"schema":{"type":"string"},"example":"[email protected]","description":"This can either be a package name e.g: `value-enhancer`, or a package name and version e.g: `[email protected]`"},{"name":"exports","in":"query","required":false,"schema":{"type":"string"},"example":"isVal,val"},{"name":"externals","in":"query","required":false,"schema":{"type":"string"},"example":"lodash,axios"},{"name":"format","in":"query","required":false,"schema":{"type":"string","enum":["min","minzip","both"]},"example":"minzip"},{"name":"style","in":"query","required":false,"description":"If not specified, the default style for this badge is \\"flat\\".","schema":{"type":"string","enum":["flat","flat-square","plastic","for-the-badge","social"]},"example":"flat"},{"name":"logo","in":"query","required":false,"description":"Icon slug from simple-icons. You can click the icon title on <a href=\\"https://simpleicons.org/\\" rel=\\"noopener noreferrer\\" target=\\"_blank\\">simple-icons</a> to copy the slug or they can be found in the <a href=\\"https://github.com/simple-icons/simple-icons/blob/master/slugs.md\\">slugs.md file</a> in the simple-icons repository. <a href=\\"/docs/logos\\">Further info</a>.","schema":{"type":"string"},"example":"appveyor"},{"name":"logoColor","in":"query","required":false,"description":"The color of the logo (hex, rgb, rgba, hsl, hsla and css named colors supported). Supported for simple-icons logos but not for custom logos.","schema":{"type":"string"},"example":"violet"},{"name":"logoSize","in":"query","required":false,"description":"Make icons adaptively resize by setting `auto`. Useful for some wider logos like `amd` and `amg`. Supported for simple-icons logos but not for custom logos.","schema":{"type":"string"},"example":"auto"},{"name":"label","in":"query","required":false,"description":"Override the default left-hand-side text (<a href=\\"https://developer.mozilla.org/en-US/docs/Glossary/percent-encoding\\">URL-Encoding</a> needed for spaces or special characters!)","schema":{"type":"string"},"example":"healthiness"},{"name":"labelColor","in":"query","required":false,"description":"Background color of the left part (hex, rgb, rgba, hsl, hsla and css named colors supported).","schema":{"type":"string"},"example":"abcdef"},{"name":"color","in":"query","required":false,"description":"Background color of the right part (hex, rgb, rgba, hsl, hsla and css named colors supported).","schema":{"type":"string"},"example":"fedcba"},{"name":"cacheSeconds","in":"query","required":false,"description":"HTTP cache lifetime (rules are applied to infer a default value on a per-badge basis, any values specified below the default will be ignored).","schema":{"type":"string"},"example":"3600"},{"name":"link","in":"query","required":false,"description":"Specify what clicking on the left/right of a badge should do. Note that this only works when integrating your badge in an `<object>` HTML tag, but not an `<img>` tag or a markup language.","style":"form","explode":true,"schema":{"type":"array","maxItems":2,"items":{"type":"string"}}}],"x-code-samples":[{"lang":"URL","label":"URL","source":"$url"},{"lang":"Markdown","label":"Markdown","source":"![npm package minimized gzipped size]($url)"},{"lang":"reStructuredText","label":"rSt","source":".. image:: $url\\n   :alt: npm package minimized gzipped size"},{"lang":"AsciiDoc","label":"AsciiDoc","source":"image:$url[npm package minimized gzipped size]"},{"lang":"HTML","label":"HTML","source":"<img alt=\\"npm package minimized gzipped size\\" src=\\"$url\\">"}],"method":"get","path":"/bundlejs/size/{packageName}","info":{"version":"1.0.0","title":"Size","license":{"name":"CC0"}},"postman":{"name":"npm package minimized gzipped size","description":{"content":"\\nView <a href=\\"https://github.com/evanw/esbuild\\" target=\\"_blank\\" rel=\\"noopener\\">esbuild</a> minified and <a href=\\"https://github.com/hazae41/denoflate\\" target=\\"_blank\\" rel=\\"noopener\\">denoflate</a> gzipped size of a javascript package or selected exports, via <a href=\\"https://bundlejs.com/\\" target=\\"_blank\\" rel=\\"noopener\\">bundlejs</a>.\\n","type":"text/plain"},"url":{"path":["bundlejs","size",":packageName"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"exports","value":"<string>"},{"disabled":false,"key":"externals","value":"<string>"},{"disabled":false,"key":"format","value":"<string>"},{"disabled":false,"description":{"content":"If not specified, the default style for this badge is \\"flat\\".","type":"text/plain"},"key":"style","value":"<string>"},{"disabled":false,"description":{"content":"Icon slug from simple-icons. You can click the icon title on <a href=\\"https://simpleicons.org/\\" rel=\\"noopener noreferrer\\" target=\\"_blank\\">simple-icons</a> to copy the slug or they can be found in the <a href=\\"https://github.com/simple-icons/simple-icons/blob/master/slugs.md\\">slugs.md file</a> in the simple-icons repository. <a href=\\"/docs/logos\\">Further info</a>.","type":"text/plain"},"key":"logo","value":"<string>"},{"disabled":false,"description":{"content":"The color of the logo (hex, rgb, rgba, hsl, hsla and css named colors supported). Supported for simple-icons logos but not for custom logos.","type":"text/plain"},"key":"logoColor","value":"<string>"},{"disabled":false,"description":{"content":"Make icons adaptively resize by setting `auto`. Useful for some wider logos like `amd` and `amg`. Supported for simple-icons logos but not for custom logos.","type":"text/plain"},"key":"logoSize","value":"<string>"},{"disabled":false,"description":{"content":"Override the default left-hand-side text (<a href=\\"https://developer.mozilla.org/en-US/docs/Glossary/percent-encoding\\">URL-Encoding</a> needed for spaces or special characters!)","type":"text/plain"},"key":"label","value":"<string>"}

1,{"disabled":false,"description":{"content":"Background color of the left part (hex, rgb, rgba, hsl, hsla and css named colors supported).","type":"text/plain"},"key":"labelColor","value":"<string>"},{"disabled":false,"description":{"content":"Background color of the right part (hex, rgb, rgba, hsl, hsla and css named colors supported).","type":"text/plain"},"key":"color","value":"<string>"},{"disabled":false,"description":{"content":"HTTP cache lifetime (rules are applied to infer a default value on a per-badge basis, any values specified below the default will be ignored).","type":"text/plain"},"key":"cacheSeconds","value":"<string>"},{"disabled":false,"description":{"content":"Specify what clicking on the left/right of a badge should do. Note that this only works when integrating your badge in an `<object>` HTML tag, but not an `<img>` tag or a markup language.","type":"text/plain"},"key":"link","value":"<string>"},{"disabled":false,"description":{"content":"Specify what clicking on the left/right of a badge should do. Note that this only works when integrating your badge in an `<object>` HTML tag, but not an `<img>` tag or a markup language.","type":"text/plain"},"key":"link","value":"<string>"}],"variable":[{"disabled":false,"description":{"content":"(Required) This can either be a package name e.g: `value-enhancer`, or a package name and version e.g: `[email protected]`","type":"text/plain"},"type":"any","value":"<string>","key":"packageName"}]},"method":"GET"}},"source":"@site/categories/size.yaml","sourceDirName":".","permalink":"/badges/npm-package-minimized-gzipped-size","previous":{"title":"npm bundle size (version)","permalink":"/badges/npm-bundle-size-version"},"next":{"title":"npm package minimized gzipped size (scoped)","permalink":"/badges/npm-package-minimized-gzipped-size-scoped"}}');var a=s(74848),l=s(28453);const r={},t="npm package minimized gzipped size",o=[];function d(e){const i={code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,l.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(i.header,{children:(0,a.jsx)(i.h1,{id:"npm-package-minimized-gzipped-size",children:"npm package minimized gzipped size"})}),"\n",(0,a.jsxs)(i.p,{children:["View ",(0,a.jsx)("a",{href:"https://github.com/evanw/esbuild",target:"_blank",rel:"noopener",children:"esbuild"})," minified and ",(0,a.jsx)("a",{href:"https://github.com/hazae41/denoflate",target:"_blank",rel:"noopener",children:"denoflate"})," gzipped size of a javascript package or selected exports, via ",(0,a.jsx)("a",{href:"https://bundlejs.com/",target:"_blank",rel:"noopener",children:"bundlejs"}),"."]}),"\n",(0,a.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,a.jsx)("thead",{children:(0,a.jsx)("tr",{children:(0,a.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,a.jsx)("tbody",{children:(0,a.jsx)("tr",{children:(0,a.jsxs)("td",{children:[(0,a.jsx)("code",{children:"packageName"}),(0,a.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,a.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,a.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,a.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,a.jsxs)(i.p,{children:["This can either be a package name e.g: ",(0,a.jsx)(i.code,{children:"value-enhancer"}),", or a package name and version e.g: ",(0,a.jsx)(i.code,{children:"[email protected]"})]})}),(0,a.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,a.jsxs)(i.p,{children:["Example:\n",(0,a.jsx)("code",{children:"[email protected]"})]})})]})})})]}),"\n",(0,a.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,a.jsx)("thead",{children:(0,a.jsx)("tr",{children:(0,a.jsx)("th",{style:{textAlign:"left"},children:"Query Parameters"})})}),(0,a.jsxs)("tbody",{children:[(0,a.jsx)("tr",{children:(0,a.jsxs)("td",{children:[(0,a.jsx)("code",{children:"exports"}),(0,a.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,a.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,a.jsxs)(i.p,{children:["Example:\n",(0,a.jsx)("code",{children:"isVal,val"})]})})]})}),(0,a.jsx)("tr",{children:(0,a.jsxs)("td",{children:[(0,a.jsx)("code",{children:"externals"}),(0,a.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,a.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,a.jsxs)(i.p,{children:["Example:\n",(0,a.jsx)("code",{children:"lodash,axios"})]})})]})}),(0,a.jsx)("tr",{children:(0,a.jsxs)("td",{children:[(0,a.jsx)("code",{children:"format"}),(0,a.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,a.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,a.jsxs)(i.p,{children:[(0,a.jsx)(i.strong,{children:"Possible values:"}

1)," [",(0,a.jsx)(i.code,{children:"min"}),", ",(0,a.jsx)(i.code,{children:"minzip"}),", ",(0,a.jsx)(i.code,{children:"both"}),"]"]})}),(0,a.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,a.jsxs)(i.p,{children:["Example:\n",(0,a.jsx)("code",{children:"minzip"})]})})]})}),(0,a.jsx)("tr",{children:(0,a.jsxs)("td",{children:[(0,a.jsx)("code",{children:"style"}),(0,a.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,a.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,a.jsxs)(i.p,{children:[(0,a.jsx)(i.strong,{children:"Possible values:"})," [",(0,a.jsx)(i.code,{children:"flat"}),", ",(0,a.jsx)(i.code,{children:"flat-square"}),", ",(0,a.jsx)(i.code,{children:"plastic"}),", ",(0,a.jsx)(i.code,{children:"for-the-badge"}),", ",(0,a.jsx)(i.code,{children:"social"}),"]"]})}),(0,a.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,a.jsx)(i.p,{children:'If not specified, the default style for this badge is "flat".'})}),(0,a.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,a.jsxs)(i.p,{children:["Example:\n",(0,a.jsx)("code",{children:"flat"})]})})]})}),(0,a.jsx)("tr",{children:(0,a.jsxs)("td",{children:[(0,a.jsx)("code",{children:"logo"}),(0,a.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,a.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,a.jsxs)(i.p,{children:["Icon slug from simple-icons. You can click the icon title on ",(0,a.jsx)("a",{href:"https://simpleicons.org/",rel:"noopener noreferrer",target:"_blank",children:"simple-icons"})," to copy the slug or they can be found in the ",(0,a.jsx)("a",{href:"https://github.com/simple-icons/simple-icons/blob/master/slugs.md",children:"slugs.md file"})," in the simple-icons repository. ",(0,a.jsx)("a",{href:"/docs/logos",children:"Further info"}),"."]})}),(0,a.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,a.jsxs)(i.p,{children:["Example:\n",(0,a.jsx)("code",{children:"appveyor"})]})})]})}),(0,a.jsx)("tr",{children:(0,a.jsxs)("td",{children:[(0,a.jsx)("code",{children:"logoColor"}),(0,a.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,a.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,a.jsx)(i.p,{children:"The color of the logo (hex, rgb, rgba, hsl, hsla and css named colors supported). Supported for simple-icons logos but not for custom logos."})}),(0,a.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,a.jsxs)(i.p,{children:["Example:\n",(0,a.jsx)("code",{children:"violet"})]})})]})}),(0,a.jsx)("tr",{children:(0,a.jsxs)("td",{children:[(0,a.jsx)("code",{children:"logoSize"}),(0,a.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,a.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,a.jsxs)(i.p,{children:["Make icons adaptively resize by setting ",(0,a.jsx)(i.code,{children:"auto"}),". Useful for some wider logos like ",(0,a.jsx)(i.code,{children:"amd"})," and ",(0,a.jsx)(i.code,{children:"amg"}),". Supported for simple-icons logos but not for custom logos."]})}),(0,a.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,a.jsxs)(i.p,{children:["Example:\n",(0,a.jsx)("code",{children:"auto"})]})})]})}),(0,a.jsx)("tr",{children:(0,a.jsxs)("td",{children:[(0,a.jsx)("code",{children:"label"}),(0,a.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,a.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,a.jsxs)(i.p,{children:["Override the default left-hand-side text (",(0,a.jsx)("a",{href:"https://developer.mozilla.org/en-US/docs/Glossary/percent-encoding",children:"URL-Encoding"})," needed for spaces or special characters!)"]})}),(0,a.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,a.jsxs)(i.p,{children:["Example:\n",(0,a.jsx)("code",{children:"healthiness"})]})})]})}),(0,a.jsx)("tr",{children:(0,a.jsxs)("td",{children:[(0,a.jsx)("code",{children:"labelColor"}),(0,a.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,a.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"}

1,children:(0,a.jsx)(i.p,{children:"Background color of the left part (hex, rgb, rgba, hsl, hsla and css named colors supported)."})}),(0,a.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,a.jsxs)(i.p,{children:["Example:\n",(0,a.jsx)("code",{children:"abcdef"})]})})]})}),(0,a.jsx)("tr",{children:(0,a.jsxs)("td",{children:[(0,a.jsx)("code",{children:"color"}),(0,a.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,a.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,a.jsx)(i.p,{children:"Background color of the right part (hex, rgb, rgba, hsl, hsla and css named colors supported)."})}),(0,a.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,a.jsxs)(i.p,{children:["Example:\n",(0,a.jsx)("code",{children:"fedcba"})]})})]})}),(0,a.jsx)("tr",{children:(0,a.jsxs)("td",{children:[(0,a.jsx)("code",{children:"cacheSeconds"}),(0,a.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,a.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,a.jsx)(i.p,{children:"HTTP cache lifetime (rules are applied to infer a default value on a per-badge basis, any values specified below the default will be ignored)."})}),(0,a.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,a.jsxs)(i.p,{children:["Example:\n",(0,a.jsx)("code",{children:"3600"})]})})]})}),(0,a.jsx)("tr",{children:(0,a.jsxs)("td",{children:[(0,a.jsx)("code",{children:"link"}),(0,a.jsx)("span",{style:{opacity:"0.6"},children:" string[]"}),(0,a.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,a.jsxs)(i.p,{children:["Specify what clicking on the left/right of a badge should do. Note that this only works when integrating your badge in an ",(0,a.jsx)(i.code,{children:"<object>"})," HTML tag, but not an ",(0,a.jsx)(i.code,{children:"<img>"})," tag or a markup language."]})})]})})]})]})]})}function c(e={}){const{wrapper:i}={...(0,l.R)(),...e.components};return i?(0,a.jsx)(i,{...e,children:(0,a.jsx)(d,{...e})}):d(e)}},28453(e,i,s){s.d(i,{R:()=>r,x:()=>t});var n=s(96540);const a={},l=n.createContext(a);function r(e){const i=n.useContext(l);return n.useMemo(function(){return"function"==typeof e?e(i):{...i,...e}},[i,e])}function t(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:r(e.components),n.createElement(l.Provider,{value:i},e.children)}}}]);