Skip to content

Commit 9654604

Browse files
BitPattyBitPatty
authored
sort readme modifiers by name
1 parent 92b119e commit 9654604

File tree

10 files changed

+153
-147
lines changed

10 files changed

+153
-147
lines changed

‎README.md‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -102,10 +102,10 @@ t.rotate(34); // rotate: 34, blur: 10
102102
- [page](#page-imgproxy-docs)
103103
- [pixelate](#pixelate-imgproxy-docs)
104104
- [pngOptions](#pngoptions-imgproxy-docs)
105-
- [resizingAlgorithm](#resizingalgorithm-imgproxy-docs)
106-
- [returnAttachment](#returnattachment-imgproxy-docs)
107105
- [quality](#quality-imgproxy-docs)
108106
- [resize](#resize-imgproxy-docs)
107+
- [resizingAlgorithm](#resizingalgorithm-imgproxy-docs)
108+
- [returnAttachment](#returnattachment-imgproxy-docs)
109109
- [rotate](#rotate-imgproxy-docs)
110110
- [saturation](#saturation-imgproxy-docs)
111111
- [sharpen](#sharpen-imgproxy-docs)
@@ -484,48 +484,48 @@ pb().pngOptions({
484484
});
485485
```
486486

487-
### resizingAlgorithm ([imgproxy docs](https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#preset))
487+
### quality ([imgproxy docs](https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#quality))
488488

489-
Defines the algorithm that imgproxy will use for resizing.
489+
Redefines the quality of the resulting image.
490490

491491
#### Example
492492

493493
```typescript
494-
pb().resizingAlgorithm(ResizingAlgorithm.NEAREST));
494+
pb().quality(80);
495495
```
496496

497-
### returnAttachment ([imgproxy docs](https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#return-attachment))
497+
### resize ([imgproxy docs](https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#resize))
498498

499-
Returns attachment in the Content-Disposition header.
499+
Resizes the image.
500500

501501
#### Example
502502

503503
```typescript
504-
pb().returnAttachment();
504+
pb().resize({
505+
type: ResizeType.AUTO, // optional
506+
width: 100, // optional
507+
height: 50 // optional
508+
});
505509
```
506510

507-
### quality ([imgproxy docs](https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#quality))
511+
### resizingAlgorithm ([imgproxy docs](https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#preset))
508512

509-
Redefines the quality of the resulting image.
513+
Defines the algorithm that imgproxy will use for resizing.
510514

511515
#### Example
512516

513517
```typescript
514-
pb().quality(80);
518+
pb().resizingAlgorithm(ResizingAlgorithm.NEAREST));
515519
```
516520

517-
### resize ([imgproxy docs](https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#resize))
521+
### returnAttachment ([imgproxy docs](https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#return-attachment))
518522

519-
Resizes the image.
523+
Returns attachment in the Content-Disposition header.
520524

521525
#### Example
522526

523527
```typescript
524-
pb().resize({
525-
type: ResizeType.AUTO, // optional
526-
width: 100, // optional
527-
height: 50 // optional
528-
});
528+
pb().returnAttachment();
529529
```
530530

531531
### rotate ([imgproxy docs](https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#rotate))

‎docs/classes/ParamBuilder.html‎

Lines changed: 55 additions & 55 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"><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 class="tsd-anchor-link">AUTO<a href="#AUTO" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">AUTO<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;auto&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/BitPatty/imgproxy-url-builder/blob/683577e/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 class="tsd-anchor-link">FILL<a href="#FILL" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">FILL<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;fill&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/BitPatty/imgproxy-url-builder/blob/683577e/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 class="tsd-anchor-link">FIT<a href="#FIT" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">FIT<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;fit&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/BitPatty/imgproxy-url-builder/blob/683577e/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"><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 class="tsd-anchor-link">AUTO<a href="#AUTO" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">AUTO<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;auto&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/BitPatty/imgproxy-url-builder/blob/92b119e/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 class="tsd-anchor-link">FILL<a href="#FILL" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">FILL<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;fill&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/BitPatty/imgproxy-url-builder/blob/92b119e/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 class="tsd-anchor-link">FIT<a href="#FIT" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">FIT<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;fit&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/BitPatty/imgproxy-url-builder/blob/92b119e/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)