@remove-background-ai/rembg.js

<!doctype html> <html lang="en"> <head> <title>Code coverage report for index.ts</title> <meta charset="utf-8" /> <link rel="stylesheet" href="prettify.css" /> <link rel="stylesheet" href="base.css" /> <link rel="shortcut icon" type="image/x-icon" href="favicon.png" /> <meta name="viewport" content="width=device-width, initial-scale=1" /> <style type='text/css'> .coverage-summary .sorter { background-image: url(sort-arrow-sprite.png); } </style> </head> <body> <div class='wrapper'> <div class='pad1'> <h1><a href="index.html">All files</a> index.ts</h1> <div class='clearfix'> <div class='fl pad1y space-right2'> 98.21% Statements 55/56 </div> <div class='fl pad1y space-right2'> 94.11% Branches 48/51 </div> <div class='fl pad1y space-right2'> 100% Functions 2/2 </div> <div class='fl pad1y space-right2'> 98.14% Lines 53/54 </div> </div> Press n or j to go to the next uncovered block, b, p or k for the previous block. <template id="filterTemplate"> <div class="quiet"> Filter: <input oninput="onInput()" type="search" id="fileSearch"> </div> </template> </div> <div class='status-line high'></div> <pre><table class="coverage"> <tr><td class="line-count quiet"><a name='L1'></a><a href='#L1'>1</a> <a name='L2'></a><a href='#L2'>2</a> <a name='L3'></a><a href='#L3'>3</a> <a name='L4'></a><a href='#L4'>4</a> <a name='L5'></a><a href='#L5'>5</a> <a name='L6'></a><a href='#L6'>6</a> <a name='L7'></a><a href='#L7'>7</a> <a name='L8'></a><a href='#L8'>8</a> <a name='L9'></a><a href='#L9'>9</a> <a name='L10'></a><a href='#L10'>10</a> <a name='L11'></a><a href='#L11'>11</a> <a name='L12'></a><a href='#L12'>12</a> <a name='L13'></a><a href='#L13'>13</a> <a name='L14'></a><a href='#L14'>14</a> <a name='L15'></a><a href='#L15'>15</a> <a name='L16'></a><a href='#L16'>16</a> <a name='L17'></a><a href='#L17'>17</a> <a name='L18'></a><a href='#L18'>18</a> <a name='L19'></a><a href='#L19'>19</a> <a name='L20'></a><a href='#L20'>20</a> <a name='L21'></a><a href='#L21'>21</a> <a name='L22'></a><a href='#L22'>22</a> <a name='L23'></a><a href='#L23'>23</a> <a name='L24'></a><a href='#L24'>24</a> <a name='L25'></a><a href='#L25'>25</a> <a name='L26'></a><a href='#L26'>26</a> <a name='L27'></a><a href='#L27'>27</a> <a name='L28'></a><a href='#L28'>28</a> <a name='L29'></a><a href='#L29'>29</a> <a name='L30'></a><a href='#L30'>30</a> <a name='L31'></a><a href='#L31'>31</a> <a name='L32'></a><a href='#L32'>32</a> <a name='L33'></a><a href='#L33'>33</a> <a name='L34'></a><a href='#L34'>34</a> <a name='L35'></a><a href='#L35'>35</a> <a name='L36'></a><a href='#L36'>36</a> <a name='L37'></a><a href='#L37'>37</a> <a name='L38'></a><a href='#L38'>38</a> <a name='L39'></a><a href='#L39'>39</a> <a name='L40'></a><a href='#L40'>40</a> <a name='L41'></a><a href='#L41'>41</a> <a name='L42'></a><a href='#L42'>42</a> <a name='L43'></a><a href='#L43'>43</a> <a name='L44'></a><a href='#L44'>44</a> <a name='L45'></a><a href='#L45'>45</a> <a name='L46'></a><a href='#L46'>46</a> <a name='L47'></a><a href='#L47'>47</a> <a name='L48'></a><a href='#L48'>48</a> <a name='L49'></a><a href='#L49'>49</a> <a name='L50'></a><a href='#L50'>50</a> <a name='L51'></a><a href='#L51'>51</a> <a name='L52'></a><a href='#L52'>52</a> <a name='L53'></a><a href='#L53'>53</a> <a name='L54'></a><a href='#L54'>54</a> <a name='L55'></a><a href='#L55'>55</a> <a name='L56'></a><a href='#L56'>56</a> <a name='L57'></a><a href='#L57'>57</a> <a name='L58'></a><a href='#L58'>58</a> <a name='L59'></a><a href='#L59'>59</a> <a name='L60'></a><a href='#L60'>60</a> <a name='L61'></a><a href='#L61'>61</a> <a name='L62'></a><a href='#L62'>62</a> <a name='L63'></a><a href='#L63'>63</a> <a name='L64'></a><a href='#L64'>64</a> <a name='L65'></a><a href='#L65'>65</a> <a name='L66'></a><a href='#L66'>66</a> <a name='L67'></a><a href='#L67'>67</a> <a name='L68'></a><a href='#L68'>68</a> <a name='L69'></a><a href='#L69'>69</a> <a name='L70'></a><a href='#L70'>70</a> <a name='L71'></a><a href='#L71'>71</a> <a name='L72'></a><a href='#L72'>72</a> <a name='L73'></a><a href='#L73'>73</a> <a name='L74'></a><a href='#L74'>74</a> <a name='L75'></a><a href='#L75'>75</a> <a name='L76'></a><a href='#L76'>76</a> <a name='L77'></a><a href='#L77'>77</a> <a name='L78'></a><a href='#L78'>78</a> <a name='L79'></a><a href='#L79'>79</a> <a name='L80'></a><a href='#L80'>80</a> <a name='L81'></a><a href='#L81'>81</a> <a name='L82'></a><a href='#L82'>82</a> <a name='L83'></a><a href='#L83'>83</a> <a name='L84'></a><a href='#L84'>84</a> <a name='L85'></a><a href='#L85'>85</a> <a name='L86'></a><a href='#L86'>86</a> <a name='L87'></a><a href='#L87'>87</a> <a name='L88'></a><a href='#L88'>88</a> <a name='L89'></a><a href='#L89'>89</a> <a name='L90'></a><a href='#L90'>90</a> <a name='L91'></a><a href='#L91'>91</a> <a name='L92'></a><a href='#L92'>92</a> <a name='L93'></a><a href='#L93'>93</a> <a name='L94'></a><a href='#L94'>94</a> <a name='L95'></a><a href='#L95'>95</a> <a name='L96'></a><a href='#L96'>96</a> <a name='L97'></a><a href='#L97'>97</a> <a name='L98'></a><a href='#L98'>98</a> <a name='L99'></a><a href='#L99'>99</a> <a name='L100'></a><a href='#L100'>100</a> <a name='L101'></a><a href='#L101'>101</a> <a name='L102'></a><a href='#L102'>102</a> <a name='L103'></a><a href='#L103'>103</a> <a name='L104'></a><a href='#L104'>104</a> <a name='L105'></a><a href='#L105'>105</a> <a name='L106'></a><a href='#L106'>106</a> <a name='L107'></a><a href='#L107'>107</a> <a name='L108'></a><a href='#L108'>108</a> <a name='L109'></a><a href='#L109'>109</a> <a name='L110'></a><a href='#L110'>110</a> <a name='L111'></a><a href='#L111'>111</a> <a name='L112'></a><a href='#L112'>112</a> <a name='L113'></a><a href='#L113'>113</a> <a name='L114'></a><a href='#L114'>114</a> <a name='L115'></a><a href='#L115'>115</a> <a name='L116'></a><a href='#L116'>116</a> <a name='L117'></a><a href='#L117'>117</a> <a name='L118'></a><a href='#L118'>118</a> <a name='L119'></a><a href='#L119'>119</a> <a name='L120'></a><a href='#L120'>120</a> <a name='L121'></a><a href='#L121'>121</a> <a name='L122'></a><a href='#L122'>122</a> <a name='L123'></a><a href='#L123'>123</a> <a name='L124'></a><a href='#L124'>124</a> <a name='L125'></a><a href='#L125'>125</a> <a name='L126'></a><a href='#L126'>126</a> <a name='L127'></a><a href='#L127'>127</a> <a name='L128'></a><a href='#L128'>128</a> <a name='L129'></a><a href='#L129'>129</a> <a name='L130'></a><a href='#L130'>130</a> <a name='L131'></a><a href='#L131'>131</a> <a name='L132'></a><a href='#L132'>132</a> <a name='L133'></a><a href='#L133'>133</a> <a name='L134'></a><a href='#L134'>134</a> <a name='L135'></a><a href='#L135'>135</a> <a name='L136'></a><a href='#L136'>136</a> <a name='L137'></a><a href='#L137'>137</a> <a name='L138'></a><a href='#L138'>138</a> <a name='L139'></a><a href='#L139'>139</a> <a name='L140'></a><a href='#L140'>140</a> <a name='L141'></a><a href='#L141'>141</a> <a name='L142'></a><a href='#L142'>142</a> <a name='L143'></a><a href='#L143'>143</a> <a name='L144'></a><a href='#L144'>144</a> <a name='L145'></a><a href='#L145'>145</a> <a name='L146'></a><a href='#L146'>146</a> <a name='L147'></a><a href='#L147'>147</a> <a name='L148'></a><a href='#L148'>148</a> <a name='L149'></a><a href='#L149'>149</a> <a name='L150'></a><a href='#L150'>150</a> <a name='L151'></a><a href='#L151'>151</a> <a name='L152'></a><a href='#L152'>152</a> <a name='L153'></a><a href='#L153'>153</a> <a name='L154'></a><a href='#L154'>154</a> <a name='L155'></a><a href='#L155'>155</a> <a name='L156'></a><a href='#L156'>156</a> <a name='L157'></a><a href='#L157'>157</a> <a name='L158'></a><a href='#L158'>158</a> <a name='L159'></a><a href='#L159'>159</a> <a name='L160'></a><a href='#L160'>160</a> <a name='L161'></a><a href='#L161'>161</a> <a name='L162'></a><a href='#L162'>162</a> <a name='L163'></a><a href='#L163'>163</a> <a name='L164'></a><a href='#L164'>164</a></td><td class="line-coverage quiet">1x 1x 1x 1x 1x                           1x                                             1x                       23x 23x                     22x   22x 22x   22x     22x   19x 3x   1x 2x   1x     1x       1x 1x     1x       21x 21x 21x 21x 21x     21x 2x   21x 3x   18x   21x 3x     21x 21x 2x       21x                         21x 21x 18x   2x 2x   16x 16x 16x       3x     1x 2x   1x       1x         1x  </td><td class="text"><pre class="prettyprint lang-js">import * as fs from 'fs'; import axios, { AxiosProgressEvent, AxiosRequestConfig } from 'axios'; import FormData from 'form-data'; import { file as tmpFile } from 'tmp-promise'; import { Buffer } from 'buffer';   type InputType = string | Buffer | { base64: string }; type Options = { returnMask?: boolean; returnBase64?: boolean; // by default, it won't return a Base64 string w: number; h: number; exact_resize?: boolean; format?: "png" | "PNG" | "webp" | "WEBP"; angle?: number; // Rotation angle in degrees expand?: boolean; // Add padding so rotated images aren't cropped bg_color?: string; // Optional solid background color in hex (e.g. #FFFFFFFF) or named color (e.g. "red", "blue") } const D_FORMAT = 'WEBP' /** * Removes the background from an image using the rembg.com API. * * @param apiKey - The API key for rembg.com. * @param inputImage - file path, Buffer, or an object with a { base64: string } property. * @param onUploadProgress - A callback function to handle upload progress events. Defaults to console.log. * @param onDownloadProgress - A callback function to handle download progress events. Defaults to console.log. * @param options - set of options for image Post processing. * @param options.returnMask - If true, returns the alpha-Matte (mask) image instead of the image. * @param options.returnBase64 - If true, returns the output image as a Base64 string instead of saving it to a file. * @param options.w - The width of the output image. * @param options.h - The height of the output image. * @param options.exact_resize - If true, the output image will be resized to the specified width and height. * @param options.format - format the image to target format, by default it is WEBP. * @param options.angle - Rotation angle in degrees (optional). * @param options.expand - Add padding so rotated images aren't cropped (optional, defaults to true). * @param options.bg_color - Optional solid background color in hex (e.g. #FFFFFFFF) or named color (e.g. "red", "blue"). * @returns If returnBase64 is true, returns an object with the base64Image property containing the Base64 string of the output image. * If returnBase64 is false, returns an object with the outputImagePath property containing the path to the output image file, * and the cleanup function to delete the temporary file. * @throws Throws an error if the API key is not provided or if the request fails. */ export const rembg = async ({ apiKey, inputImage, options, onUploadProgress = console.log, // it will log every uploadProgress event by default onDownloadProgress = console.log, // it will log every uploadProgress event by default }: { apiKey: string; inputImage: InputType; options?: Options; onUploadProgress: (progressEvent: AxiosProgressEvent) => void; onDownloadProgress: (progressEvent: AxiosProgressEvent) => void; }) => { if (!apiKey) throw new Error(' ⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️: API key not provided, trials will be very limited.');   const { returnMask = false, returnBase64 = false, w = 0, h = 0, exact_resize = false, angle, expand, bg_color } = options || {};   const url = "https://api.rembg.com/rmbg"; const API_KEY_HEADER = "x-api-key";   const data = new FormData();   // Handle different input types if (typeof inputImage === 'string') { // Input is a file path data.append('image', fs.createReadStream(inputImage)); } else if (Buffer.isBuffer(inputImage)) { // Input is a Buffer data.append('image', inputImage, { filename: 'image.png' }); } else if (typeof inputImage === 'object' && 'base64' in inputImage) { // Input is a base64 string let base64Data = inputImage.base64; // Remove data URL prefix if present Iif (base64Data.startsWith('data:')) { base64Data = base64Data.split(',')[1]; } const buffer = Buffer.from(base64Data, 'base64'); data.append('image', buffer, { filename: 'image.png', contentType: 'image/png' });   } else { throw new Error('Invalid input type. Must be a file path, Buffer, or an object with a base64 property.'); }     data.append('exact_resize', exact_resize.toString()); data.append('w', w); data.append('h', h); data.append('mask', returnMask.toString()); data.append('return_base64', returnBase64.toString()); // Add new parameters if provided if (angle !== undefined) { data.append('angle', angle.toString()); } if (expand !== undefined) { data.append('expand', expand.toString()); } else { data.append('expand', 'true'); // Default value when not provided } if (bg_color !== undefined) { data.append('bg_color', bg_color); } const format = options?.format if(format && format.toLowerCase() === "png" || format?.toLowerCase() === "webp") { data.append('format', options?.format) }     const config = { method: 'post', maxBodyLength: Infinity, url, headers: { [API_KEY_HEADER]: apiKey, ...data.getHeaders() }, data, responseType: 'arraybuffer', onUploadProgress, onDownloadProgress } as AxiosRequestConfig<FormData>; try { const response = await axios.request(config); if (returnBase64) { // Return a base64 string if returnBase64 is true const base64Image = `data:image/png;base64,${Buffer.from(response.data).toString('base64')}`; return { base64Image }; } else { const { path: outputImagePath, cleanup } = await tmpFile({ prefix: 'rembg-', postfix: `.${options?.format || D_FORMAT}` }); fs.writeFileSync(outputImagePath, response.data); return { outputImagePath, cleanup }; } } catch (error: any) {   if (error.response) { // The request was made and the server responded with a status code // that falls out of the range of 2xx throw new Error(`❌ ${error.response.status} ${error.response.data.toString()}`); } else if (error.request) { // The request was made but no response was received throw new Error(`❌ ${error.message}`);   } else { // Something happened in setting up the request that triggered an Error throw new Error(`❌ Request failed ${error.message}`); } } }   export default rembg;  </pre></td></tr></table></pre> <div class='push'></div> </div> <div class='footer quiet pad2 space-top1 center small'> Code coverage generated by <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a> at 2025-09-13T13:30:55.072Z </div> <script src="prettify.js"></script> <script> window.onload = function () { prettyPrint(); }; </script> <script src="sorter.js"></script> <script src="block-navigation.js"></script> </body> </html>