Skip to content

docs: update image loading via browser #122

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 25, 2025
Merged

docs: update image loading via browser #122

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fac4168
docs: update image loading via browser
EscapedGibbon Mar 25, 2025
73b135f
docs: add anchor link to "loading image in browser"
EscapedGibbon Mar 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 6 additions & 13 deletions docs/Getting started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ const parsedImage = readSync('../example.jpg');
```

:::tip
Node.js can also load an image via `fetch` function. To get more information take a look at "Browser" part of this section.
Node.js can also load an image via `fetchURL`. To get more information take a look at ["Browser"](#loading-your-first-image-in-browser) part of this section.
:::

Once the image is loaded, it returns an instance of the `Image` class, so its methods can be applied.
Expand Down Expand Up @@ -72,13 +72,12 @@ writeSync('../example.jpg', image);

### Loading your first image in browser

To load an image via browser, in order to instantiate it, you need to get an `arrayBuffer`. One of the ways :
To load an image via browser, in order to instantiate it, you may use `fetchURL` function:

```ts
const data = await fetch('https:://example.com/image.jpg');
const bufferedData = await data.arrayBuffer();
let image = decode(new DataView(bufferedData)); // image is ready for usage
import { fetchURL } from 'image-js';

let image = await fetchURL('https:://example.com/image.jpg'); // image is ready for usage
image = image.grey();
```

Expand Down Expand Up @@ -129,10 +128,7 @@ In the `<body>` part of your code insert your `image-js` script. For instance, h
```html
<script type="module">
import {(Image, writeCanvas)} from 'image-js';
const data = await fetch('https:://example.com/image.jpg');
const bufferedData = await data.arrayBuffer();
let image = decode(new DataView(bufferedData)); // image is ready for usage

let image = await fetchURL('https:://example.com/image.jpg'); // image is ready for usage
image = image.grey();
const canvas = document.getElementById('my_canvas');
writeCanvas(image, canvas);
Expand All @@ -159,12 +155,9 @@ Thus, in the end your html page should look like this:
<canvas id="my_canvas" />
<script type="module">
import {Image, writeCanvas,decode} from 'image-js';
const data = await fetch('https:://example.com/image.jpg');
const bufferedData = await data.arrayBuffer();
let image = decode(new DataView(bufferedData)); // image is ready for usage
let image = await fetchURL('https:://example.com/image.jpg'); // image is ready for usage

image = image.grey();
console.log(Image);
const canvas = document.getElementById('my_canvas');
writeCanvas(image, canvas);
</script>
Expand Down