Skip to content

Commit 1511df4

Browse files
committed
chore: update docs
1 parent 69605d7 commit 1511df4

File tree

8 files changed

+16
-16
lines changed

8 files changed

+16
-16
lines changed

docs.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
"sidebar": [
66
["Overview", "/"],
77
[
8-
"Storage Image Processing Api",
8+
"Image Processing Api",
99
[
1010
["Overview", "/image-processing-api"],
1111
["Input", "/image-processing-api/input"],

docs/image-processing-api/index.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Storage Image Processing API
1+
# Image Processing API
22

3-
The Storage Image Processing API extension (`image-processing-api`) lets you optimize and transform images in the [Cloud Storage](https://firebase.google.com/docs/storage) bucket via a powerful HTTP API. The API provides more than 30 different operations to enhance and manipulate your images, including image composition, cropping, flipping, color reduction, sharpening, filtering, and much more. See the full list of available operations in the [Operations](/operations) documentation.
3+
The Image Processing API extension (`image-processing-api`) lets you optimize and transform images in the [Cloud Storage](https://firebase.google.com/docs/storage) bucket via a powerful HTTP API. The API provides more than 30 different operations to enhance and manipulate your images, including image composition, cropping, flipping, color reduction, sharpening, filtering, and much more. See the full list of available operations in the [Operations](/operations) documentation.
44

55
<video width="100%" controls muted autoPlay loop>
66
<source
@@ -22,7 +22,7 @@ To install the extension, follow the steps on the [Install Firebase Extension](h
2222
>
2323
<img
2424
src="https://github.com/FirebaseExtended/experimental-extensions/raw/next/install-extension.png?raw=true"
25-
alt="Install the Storage Image Processing API extension"
25+
alt="Install the Image Processing API extension"
2626
/>
2727
</a>
2828

docs/image-processing-api/utility-libray.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Once installed, import the `builder` function from the library:
1717
import { builder } from '@invertase/image-processing-api';
1818
```
1919

20-
The `builder` function returns a new `StorageImageProcessingApi` instance which provides a API for constructing operations to send to the API.
20+
The `builder` function returns a new `ImageProcessingApi` instance which provides a API for constructing operations to send to the API.
2121
At a minimum, you must provide an `input` and `output` operation as required by the extension itself:
2222

2323
```ts

docs/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,4 @@
88

99
| Name | Description |
1010
| ------------------------------------------------------------- | :-------------------------------------------------------------: |
11-
| [Storage Image Processing Api](/image-processing-api) | Firebase deployed function for processing and rendering images. |
11+
| [Image Processing Api](/image-processing-api) | Firebase deployed function for processing and rendering images. |

extensions/image-processing-api/CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,4 @@ Updated convolve feature to allow the correct number of inputs
44

55
## Version 0.0.1
66

7-
Initial release of the **Storage Image Processing Api** extension.
7+
Initial release of the **Image Processing Api** extension.

extensions/image-processing-api/lib/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Storage Image Processing API Utilities
1+
# Image Processing API Utilities
22

3-
This package contains utilities for interacting with the Firebase Storage Image Processing API Extension.
3+
This package contains utilities for interacting with the Firebase Image Processing API Extension.
44

55
## Installation
66

@@ -12,7 +12,7 @@ npm i --save @invertase/image-processing-api
1212

1313
### `builder`
1414

15-
Returns a `StorageImageProcessingApi` instance which can be used to build an array of operations to be applied to an image via the extension.
15+
Returns a `ImageProcessingApi` instance which can be used to build an array of operations to be applied to an image via the extension.
1616

1717
```ts
1818
import { builder } from '@invertase/image-processing-api';

extensions/image-processing-api/lib/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@invertase/image-processing-api",
33
"version": "0.1.0",
4-
"description": "A JavaScript utility library for the Firebase Storage Image Processing API Extension.",
4+
"description": "A JavaScript utility library for the Firebase Image Processing API Extension.",
55
"main": "dist/bundle.cjs.js",
66
"module": "dist/bundle.es.js",
77
"types": "dist/index.d.ts",

extensions/image-processing-api/lib/src/index.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ type Operations = Array<
121121
}
122122
>;
123123

124-
class StorageImageProcessingApi {
124+
class ImageProcessingApi {
125125
#input: OperationInput | undefined = undefined;
126126
#output: OperationOutput | undefined = undefined;
127127
#operations: Operations = [];
@@ -429,7 +429,7 @@ class StorageImageProcessingApi {
429429
}
430430

431431
/**
432-
* Returns a new instance of the StorageImageProcessingApi.
432+
* Returns a new instance of the ImageProcessingApi.
433433
*
434434
* Example:
435435
*
@@ -447,8 +447,8 @@ class StorageImageProcessingApi {
447447
* .toJSON();
448448
* ```
449449
*
450-
* @returns {StorageImageProcessingApi}
450+
* @returns {ImageProcessingApi}
451451
*/
452-
export function builder(): StorageImageProcessingApi {
453-
return new StorageImageProcessingApi();
452+
export function builder(): ImageProcessingApi {
453+
return new ImageProcessingApi();
454454
}

0 commit comments

Comments
 (0)