aboutsummaryrefslogtreecommitdiff
path: root/docs/api/image.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/api/image.md')
-rw-r--r--docs/api/image.md318
1 files changed, 318 insertions, 0 deletions
diff --git a/docs/api/image.md b/docs/api/image.md
new file mode 100644
index 00000000..1556ab34
--- /dev/null
+++ b/docs/api/image.md
@@ -0,0 +1,318 @@
+# Image
+
+[[toc]]
+
+## Image
+
+Return [lorempixel](http://lorempixel.com/) url
+
+::: tip
+| Param | Type | Default |
+| --------- | ------- | :-----: |
+| width | number | `640` |
+| height | number | `480` |
+| randomize | boolean | `false` |
+:::
+
+```js
+faker.image.image(); // http://lorempixel.com/640/480/nightlife
+faker.image.image(200); // http://lorempixel.com/200/480/sports
+faker.image.image(200, 600); // http://lorempixel.com/200/600/animals
+faker.image.image(200, 600, true); // http://lorempixel.com/200/600/transport?12438
+```
+
+## Avatar
+
+Return random avatar url
+
+```js
+faker.image.avatar(); // https://s3.amazonaws.com/uifaces/faces/twitter/martip07/128.jpg
+```
+
+## Data URI
+
+Return random data uri
+
+::: tip
+| Param | Type | Default |
+| ------ | ------ | :-----: |
+| width | number | `null` |
+| height | number | `null` |
+:::
+
+```js
+faker.image.dataUri();
+// data:image/svg+xml;charset=UTF-8,%3Csvg%20xmlns%3D%22http%3A%2F%2Fwww.w3.org%2F2000%2Fsvg%22%20version%3D%221.1%22%20baseProfile%3D%22full%22%20width%3D%22undefined%22%20height%3D%22undefined%22%3E%20%3Crect%20width%3D%22100%25%22%20height%3D%22100%25%22%20fill%3D%22grey%22%2F%3E%20%20%3Ctext%20x%3D%220%22%20y%3D%2220%22%20font-size%3D%2220%22%20text-anchor%3D%22start%22%20fill%3D%22white%22%3Eundefinedxundefined%3C%2Ftext%3E%20%3C%2Fsvg%3E
+```
+
+## Image URL
+
+Return [lorempixel](http://lorempixel.com/) url
+
+::: tip
+| Param | Type | Default |
+| --------- | ------- | :-----: |
+| width | number | `640` |
+| height | number | `480` |
+| category | string | `480` |
+| randomize | boolean | `false` |
+| https | boolean | `false` |
+
+**Category Options:** `abstract` `animals` `business` `cats` `city` `food` `nightlife` `fashion` `people` `nature` `sports` `technics` `transport`
+:::
+
+```js
+faker.image.imageUrl(); // http://lorempixel.com/640/480
+faker.image.imageUrl(200); // http://lorempixel.com/200/480
+faker.image.imageUrl(200, 600); // http://lorempixel.com/200/600
+faker.image.imageUrl(200, 600, 'animals'); // http://lorempixel.com/200/600/animals
+faker.image.imageUrl(200, 600, 'animals', true); // http://lorempixel.com/200/600/animals?3853
+faker.image.imageUrl(200, 600, 'animals', true, true); // https://lorempixel.com/200/600/animals?98461
+```
+
+## Abstract Image
+
+Return [lorempixel](http://lorempixel.com/) url from abstract category
+
+::: tip
+| Param | Type | Default |
+| --------- | ------- | :-----: |
+| width | number | `640` |
+| height | number | `480` |
+| randomize | boolean | `false` |
+:::
+
+```js
+faker.image.abstract(); // http://lorempixel.com/640/480/abstract
+faker.image.abstract(200); // http://lorempixel.com/200/480/abstract
+faker.image.abstract(200, 600); // http://lorempixel.com/200/600/abstract
+faker.image.abstract(200, 600, true); // http://lorempixel.com/200/600/abstract?89872
+```
+
+## Animal Image
+
+Return [lorempixel](http://lorempixel.com/) url from animals category
+
+::: tip
+| Param | Type | Default |
+| --------- | ------- | :-----: |
+| width | number | `640` |
+| height | number | `480` |
+| randomize | boolean | `false` |
+:::
+
+```js
+faker.image.animals(); // http://lorempixel.com/640/480/animals
+faker.image.animals(200); // http://lorempixel.com/200/480/animals
+faker.image.animals(200, 600); // http://lorempixel.com/200/600/animals
+faker.image.animals(200, 600, true); // http://lorempixel.com/200/600/animals?89872
+```
+
+## Business Image
+
+Return [lorempixel](http://lorempixel.com/) url from business category
+
+::: tip
+| Param | Type | Default |
+| --------- | ------- | :-----: |
+| width | number | `640` |
+| height | number | `480` |
+| randomize | boolean | `false` |
+:::
+
+```js
+faker.image.business(); // http://lorempixel.com/640/480/business
+faker.image.business(200); // http://lorempixel.com/200/480/business
+faker.image.business(200, 600); // http://lorempixel.com/200/600/business
+faker.image.business(200, 600, true); // http://lorempixel.com/200/600/business?89872
+```
+
+## Cat Image
+
+Return [lorempixel](http://lorempixel.com/) url from cats category
+
+::: tip
+| Param | Type | Default |
+| --------- | ------- | :-----: |
+| width | number | `640` |
+| height | number | `480` |
+| randomize | boolean | `false` |
+:::
+
+```js
+faker.image.cats(); // http://lorempixel.com/640/480/cats
+faker.image.cats(200); // http://lorempixel.com/200/480/cats
+faker.image.cats(200, 600); // http://lorempixel.com/200/600/cats
+faker.image.cats(200, 600, true); // http://lorempixel.com/200/600/cats?89872
+```
+
+## City Image
+
+Return [lorempixel](http://lorempixel.com/) url from city category
+
+::: tip
+| Param | Type | Default |
+| --------- | ------- | :-----: |
+| width | number | `640` |
+| height | number | `480` |
+| randomize | boolean | `false` |
+:::
+
+```js
+faker.image.city(); // http://lorempixel.com/640/480/city
+faker.image.city(200); // http://lorempixel.com/200/480/city
+faker.image.city(200, 600); // http://lorempixel.com/200/600/city
+faker.image.city(200, 600, true); // http://lorempixel.com/200/600/city?89872
+```
+
+## Food Image
+
+Return [lorempixel](http://lorempixel.com/) url from food category
+
+::: tip
+| Param | Type | Default |
+| --------- | ------- | :-----: |
+| width | number | `640` |
+| height | number | `480` |
+| randomize | boolean | `false` |
+:::
+
+```js
+faker.image.food(); // http://lorempixel.com/640/480/food
+faker.image.food(200); // http://lorempixel.com/200/480/food
+faker.image.food(200, 600); // http://lorempixel.com/200/600/food
+faker.image.food(200, 600, true); // http://lorempixel.com/200/600/food?89872
+```
+
+## Nightlife Image
+
+Return [lorempixel](http://lorempixel.com/) url from nightlife category
+
+::: tip
+| Param | Type | Default |
+| --------- | ------- | :-----: |
+| width | number | `640` |
+| height | number | `480` |
+| randomize | boolean | `false` |
+:::
+
+```js
+faker.image.nightlife(); // http://lorempixel.com/640/480/nightlife
+faker.image.nightlife(200); // http://lorempixel.com/200/480/nightlife
+faker.image.nightlife(200, 600); // http://lorempixel.com/200/600/nightlife
+faker.image.nightlife(200, 600, true); // http://lorempixel.com/200/600/nightlife?89872
+```
+
+## Fashion Image
+
+Return [lorempixel](http://lorempixel.com/) url from fashion category
+
+::: tip
+| Param | Type | Default |
+| --------- | ------- | :-----: |
+| width | number | `640` |
+| height | number | `480` |
+| randomize | boolean | `false` |
+:::
+
+```js
+faker.image.fashion(); // http://lorempixel.com/640/480/fashion
+faker.image.fashion(200); // http://lorempixel.com/200/480/fashion
+faker.image.fashion(200, 600); // http://lorempixel.com/200/600/fashion
+faker.image.fashion(200, 600, true); // http://lorempixel.com/200/600/fashion?89872
+```
+
+## People Image
+
+Return [lorempixel](http://lorempixel.com/) url from people category
+
+::: tip
+| Param | Type | Default |
+| --------- | ------- | :-----: |
+| width | number | `640` |
+| height | number | `480` |
+| randomize | boolean | `false` |
+:::
+
+```js
+faker.image.people(); // http://lorempixel.com/640/480/people
+faker.image.people(200); // http://lorempixel.com/200/480/people
+faker.image.people(200, 600); // http://lorempixel.com/200/600/people
+faker.image.people(200, 600, true); // http://lorempixel.com/200/600/people?89872
+```
+
+## Nature Image
+
+Return [lorempixel](http://lorempixel.com/) url from nature category
+
+::: tip
+| Param | Type | Default |
+| --------- | ------- | :-----: |
+| width | number | `640` |
+| height | number | `480` |
+| randomize | boolean | `false` |
+:::
+
+```js
+faker.image.nature(); // http://lorempixel.com/640/480/nature
+faker.image.nature(200); // http://lorempixel.com/200/480/nature
+faker.image.nature(200, 600); // http://lorempixel.com/200/600/nature
+faker.image.nature(200, 600, true); // http://lorempixel.com/200/600/nature?89872
+```
+
+## Sports Image
+
+Return [lorempixel](http://lorempixel.com/) url from sports category
+
+::: tip
+| Param | Type | Default |
+| --------- | ------- | :-----: |
+| width | number | `640` |
+| height | number | `480` |
+| randomize | boolean | `false` |
+:::
+
+```js
+faker.image.sports(); // http://lorempixel.com/640/480/sports
+faker.image.sports(200); // http://lorempixel.com/200/480/sports
+faker.image.sports(200, 600); // http://lorempixel.com/200/600/sports
+faker.image.sports(200, 600, true); // http://lorempixel.com/200/600/sports?89872
+```
+
+## Technics Image
+
+Return [lorempixel](http://lorempixel.com/) url from technics category
+
+::: tip
+| Param | Type | Default |
+| --------- | ------- | :-----: |
+| width | number | `640` |
+| height | number | `480` |
+| randomize | boolean | `false` |
+:::
+
+```js
+faker.image.technics(); // http://lorempixel.com/640/480/technics
+faker.image.technics(200); // http://lorempixel.com/200/480/technics
+faker.image.technics(200, 600); // http://lorempixel.com/200/600/technics
+faker.image.technics(200, 600, true); // http://lorempixel.com/200/600/technics?89872
+```
+
+## Transport Image
+
+Return [lorempixel](http://lorempixel.com/) url from transport category
+
+::: tip
+| Param | Type | Default |
+| --------- | ------- | :-----: |
+| width | number | `640` |
+| height | number | `480` |
+| randomize | boolean | `false` |
+:::
+
+```js
+faker.image.transport(); // http://lorempixel.com/640/480/transport
+faker.image.transport(200); // http://lorempixel.com/200/480/transport
+faker.image.transport(200, 600); // http://lorempixel.com/200/600/transport
+faker.image.transport(200, 600, true); // http://lorempixel.com/200/600/transport?89872
+```
generated by cgit v1.2.3 (git 2.25.1) at 2026-06-06 08:10:09 +0000