Skip to content

Commit f35ef69

Browse files
BitPattyBitPatty
authored
update readme
1 parent 2a631ba commit f35ef69

File tree

9 files changed

+58
-58
lines changed

9 files changed

+58
-58
lines changed

‎README.md‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -22,26 +22,26 @@ import pb from '@bitpatty/imgproxy-url-builder';
2222
pb().rotate(90).blur(10).build();
2323

2424
// The transformer params with the target image
25-
// Returns /rot:90/bl:10/bXlpbWFnZS5wbmc
25+
// Returns /rot:90/bl:10/czM6Ly9teWJ1Y2tldC9teWltYWdlLnBuZw
2626
pb().rotate(90).blur(10).build({
27-
path: 'myimage.png',
27+
path: 's3://mybucket/myimage.png',
2828
});
2929

3030
// You can disable path encoding by setting 'plain' to true
31-
// Returns rot:90/bl:10/plain/myimage.png
31+
// Returns /rot:90/bl:10/plain/s3://mybucket/myimage.png
3232
pb().rotate(90).blur(10).build({
33-
plain: true
34-
path: 'myimage.png',
33+
plain: true,
34+
path: 's3://mybucket/myimage.png',
3535
});
3636

3737
// To sign your URL provide the key and salt
3838
// The path is required to sign your URL!
39-
// Returns /G-Rj8JZAxQSnYcMNXMNrhkGaid3d7NfjaBJNuaV4ebA/rot:90/bl:10/bXlpbWFnZS5wbmc
39+
// Returns /TXf2QXtZkU-ULvrg0pLDqJlWUb7XdHkXD0h6NFWD-mo/rot:90/bl:10/czM6Ly9teWJ1Y2tldC9teWltYWdlLnBuZw
4040
pb()
4141
.rotate(90)
4242
.blur(10)
4343
.build({
44-
path: 'myimage.png',
44+
path: 's3://mybucket/myimage.png',
4545
signature: {
4646
key: 'a91bdcda48ce22cd7d8d3a0eda93',
4747
salt: 'a91bdcda48ce22cd7d8d3a0eda93',
@@ -50,9 +50,9 @@ pb()
5050

5151
// To automatically prepend the imgproxy URL
5252
// provide it as the 'baseUrl' setting
53-
// Returns https://my-imgproxy-instance.example.com/rot:90/bl:10/bXlpbWFnZS5wbmc
53+
// Returns https://my-imgproxy-instance.example.com/rot:90/bl:10/czM6Ly9teWJ1Y2tldC9teWltYWdlLnBuZw
5454
pb().rotate(90).blur(10).build({
55-
path: 'myimage.png',
55+
path: 's3://mybucket/myimage.png',
5656
baseUrl: 'https://my-imgproxy-instance.example.com',
5757
});
5858
```

‎docs/classes/ParamBuilder.html‎

Lines changed: 37 additions & 37 deletions
Large diffs are not rendered by default.

‎docs/enums/GravityType.html‎

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

‎docs/enums/ResizeType.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ResizeType | @bitpatty/imgproxy-url-builder</title><meta name="description" content="Documentation for @bitpatty/imgproxy-url-builder"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@bitpatty/imgproxy-url-builder</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@bitpatty/imgproxy-url-builder</a></li><li><a href="ResizeType.html">ResizeType</a></li></ul><h1>Enumeration ResizeType</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Enumeration members</h3><ul class="tsd-index-list"><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="ResizeType.html#AUTO" class="tsd-kind-icon">AUTO</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="ResizeType.html#FILL" class="tsd-kind-icon">FILL</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="ResizeType.html#FIT" class="tsd-kind-icon">FIT</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Enumeration members</h2><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="AUTO" class="tsd-anchor"></a><h3>AUTO</h3><div class="tsd-signature tsd-kind-icon">AUTO<span class="tsd-signature-symbol"> = &quot;auto&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/BitPatty/imgproxy-url-builder/blob/22b64cd/src/enums/resize-type.enum.ts#L4">enums/resize-type.enum.ts:4</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="FILL" class="tsd-anchor"></a><h3>FILL</h3><div class="tsd-signature tsd-kind-icon">FILL<span class="tsd-signature-symbol"> = &quot;fill&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/BitPatty/imgproxy-url-builder/blob/22b64cd/src/enums/resize-type.enum.ts#L3">enums/resize-type.enum.ts:3</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="FIT" class="tsd-anchor"></a><h3>FIT</h3><div class="tsd-signature tsd-kind-icon">FIT<span class="tsd-signature-symbol"> = &quot;fit&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/BitPatty/imgproxy-url-builder/blob/22b64cd/src/enums/resize-type.enum.ts#L2">enums/resize-type.enum.ts:2</a></li></ul></aside></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-enum"><a href="ResizeType.html" class="tsd-kind-icon">Resize<wbr/>Type</a><ul><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="ResizeType.html#AUTO" class="tsd-kind-icon">AUTO</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="ResizeType.html#FILL" class="tsd-kind-icon">FILL</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="ResizeType.html#FIT" class="tsd-kind-icon">FIT</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
1+
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ResizeType | @bitpatty/imgproxy-url-builder</title><meta name="description" content="Documentation for @bitpatty/imgproxy-url-builder"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@bitpatty/imgproxy-url-builder</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@bitpatty/imgproxy-url-builder</a></li><li><a href="ResizeType.html">ResizeType</a></li></ul><h1>Enumeration ResizeType</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Enumeration members</h3><ul class="tsd-index-list"><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="ResizeType.html#AUTO" class="tsd-kind-icon">AUTO</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="ResizeType.html#FILL" class="tsd-kind-icon">FILL</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="ResizeType.html#FIT" class="tsd-kind-icon">FIT</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Enumeration members</h2><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="AUTO" class="tsd-anchor"></a><h3>AUTO</h3><div class="tsd-signature tsd-kind-icon">AUTO<span class="tsd-signature-symbol"> = &quot;auto&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/BitPatty/imgproxy-url-builder/blob/2a631ba/src/enums/resize-type.enum.ts#L4">enums/resize-type.enum.ts:4</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="FILL" class="tsd-anchor"></a><h3>FILL</h3><div class="tsd-signature tsd-kind-icon">FILL<span class="tsd-signature-symbol"> = &quot;fill&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/BitPatty/imgproxy-url-builder/blob/2a631ba/src/enums/resize-type.enum.ts#L3">enums/resize-type.enum.ts:3</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="FIT" class="tsd-anchor"></a><h3>FIT</h3><div class="tsd-signature tsd-kind-icon">FIT<span class="tsd-signature-symbol"> = &quot;fit&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/BitPatty/imgproxy-url-builder/blob/2a631ba/src/enums/resize-type.enum.ts#L2">enums/resize-type.enum.ts:2</a></li></ul></aside></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-enum"><a href="ResizeType.html" class="tsd-kind-icon">Resize<wbr/>Type</a><ul><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="ResizeType.html#AUTO" class="tsd-kind-icon">AUTO</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="ResizeType.html#FILL" class="tsd-kind-icon">FILL</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="ResizeType.html#FIT" class="tsd-kind-icon">FIT</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>

0 commit comments

Comments
 (0)