import type { Faker } from '.'; import { LoremPicsum } from './image_providers/lorempicsum'; import { Lorempixel } from './image_providers/lorempixel'; import { Unsplash } from './image_providers/unsplash'; /** * Module to generate placeholder images. * * Default provider is unsplash image provider. */ export declare class Image { private readonly faker; readonly lorempixel: Lorempixel; readonly unsplash: Unsplash; readonly lorempicsum: LoremPicsum; constructor(faker: Faker); /** * Generates a random image url from one of the supported categories. * * @param width The width of the image. Defaults to `640`. * @param height The height of the image. Defaults to `480`. * @param randomize Whether to randomize the image or not. Defaults to `false`. * * @example * faker.image.image() // 'http://loremflickr.com/640/480/city' * faker.image.image(1234, 2345) // 'http://loremflickr.com/1234/2345/sports' * faker.image.image(1234, 2345, true) // 'http://loremflickr.com/1234/2345/nature?56789' */ image(width?: number, height?: number, randomize?: boolean): string; /** * Generates a random avatar image url. * * @example * faker.image.avatar() * // 'https://cloudflare-ipfs.com/ipfs/Qmd3W5DuhgHirLHGVixi6V76LhCkZUz6pnFt5AJBiyvHye/avatar/170.jpg' */ avatar(): string; /** * Generates a random image url. * * @param width The width of the image. Defaults to `640`. * @param height The height of the image. Defaults to `480`. * @param category The category of the image. By default, a random one will be selected. * @param randomize Whether to randomize the image or not. Defaults to `false`. * @param https When true, return a `https` url. Otherwise, return a `http` url. * * @example * faker.image.imageUrl() // 'http://loremflickr.com/640/480' * faker.image.imageUrl(1234, 2345) // 'http://loremflickr.com/1234/2345' * faker.image.imageUrl(1234, 2345, 'cat') // 'http://loremflickr.com/1234/2345/cat' * faker.image.imageUrl(1234, 2345, 'cat', true) // 'http://loremflickr.com/1234/2345/cat?6849' * faker.image.imageUrl(1234, 2345, 'cat', true, true) // 'https://loremflickr.com/1234/2345/cat?56789' */ imageUrl(width?: number, height?: number, category?: string, randomize?: boolean, https?: boolean): string; /** * Generates a random abstract image url. * * @param width The width of the image. Defaults to `640`. * @param height The height of the image. Defaults to `480`. * @param randomize Whether to randomize the image or not. Defaults to `false`. * * @example * faker.image.abstract() // 'http://loremflickr.com/640/480/abstract' * faker.image.abstract(1234, 2345) // 'http://loremflickr.com/1234/2345/abstract' * faker.image.abstract(1234, 2345, true) // 'http://loremflickr.com/1234/2345/abstract?56789' */ abstract(width?: number, height?: number, randomize?: boolean): string; /** * Generates a random animal image url. * * @param width The width of the image. Defaults to `640`. * @param height The height of the image. Defaults to `480`. * @param randomize Whether to randomize the image or not. Defaults to `false`. * * @example * faker.image.animals() // 'http://loremflickr.com/640/480/animals' * faker.image.animals(1234, 2345) // 'http://loremflickr.com/1234/2345/animals' * faker.image.animals(1234, 2345, true) // 'http://loremflickr.com/1234/2345/animals?56789' */ animals(width?: number, height?: number, randomize?: boolean): string; /** * Generates a random business image url. * * @param width The width of the image. Defaults to `640`. * @param height The height of the image. Defaults to `480`. * @param randomize Whether to randomize the image or not. Defaults to `false`. * * @example * faker.image.business() // 'http://loremflickr.com/640/480/business' * faker.image.business(1234, 2345) // 'http://loremflickr.com/1234/2345/business' * faker.image.business(1234, 2345, true) // 'http://loremflickr.com/1234/2345/business?56789' */ business(width?: number, height?: number, randomize?: boolean): string; /** * Generates a random cat image url. * * @param width The width of the image. Defaults to `640`. * @param height The height of the image. Defaults to `480`. * @param randomize Whether to randomize the image or not. Defaults to `false`. * * @example * faker.image.cats() // 'http://loremflickr.com/640/480/cats' * faker.image.cats(1234, 2345) // 'http://loremflickr.com/1234/2345/cats' * faker.image.cats(1234, 2345, true) // 'http://loremflickr.com/1234/2345/cats?56789' */ cats(width?: number, height?: number, randomize?: boolean): string; /** * Generates a random city image url. * * @param width The width of the image. Defaults to `640`. * @param height The height of the image. Defaults to `480`. * @param randomize Whether to randomize the image or not. Defaults to `false`. * * @example * faker.image.city() // 'http://loremflickr.com/640/480/city' * faker.image.city(1234, 2345) // 'http://loremflickr.com/1234/2345/city' * faker.image.city(1234, 2345, true) // 'http://loremflickr.com/1234/2345/city?56789' */ city(width?: number, height?: number, randomize?: boolean): string; /** * Generates a random food image url. * * @param width The width of the image. Defaults to `640`. * @param height The height of the image. Defaults to `480`. * @param randomize Whether to randomize the image or not. Defaults to `false`. * * @example * faker.image.food() // 'http://loremflickr.com/640/480/food' * faker.image.food(1234, 2345) // 'http://loremflickr.com/1234/2345/food' * faker.image.food(1234, 2345, true) // 'http://loremflickr.com/1234/2345/food?56789' */ food(width?: number, height?: number, randomize?: boolean): string; /** * Generates a random nightlife image url. * * @param width The width of the image. Defaults to `640`. * @param height The height of the image. Defaults to `480`. * @param randomize Whether to randomize the image or not. Defaults to `false`. * * @example * faker.image.nightlife() // 'http://loremflickr.com/640/480/nightlife' * faker.image.nightlife(1234, 2345) // 'http://loremflickr.com/1234/2345/nightlife' * faker.image.nightlife(1234, 2345, true) // 'http://loremflickr.com/1234/2345/nightlife?56789' */ nightlife(width?: number, height?: number, randomize?: boolean): string; /** * Generates a random fashion image url. * * @param width The width of the image. Defaults to `640`. * @param height The height of the image. Defaults to `480`. * @param randomize Whether to randomize the image or not. Defaults to `false`. * * @example * faker.image.fashion() // 'http://loremflickr.com/640/480/fashion' * faker.image.fashion(1234, 2345) // 'http://loremflickr.com/1234/2345/fashion' * faker.image.fashion(1234, 2345, true) // 'http://loremflickr.com/1234/2345/fashion?56789' */ fashion(width?: number, height?: number, randomize?: boolean): string; /** * Generates a random people image url. * * @param width The width of the image. Defaults to `640`. * @param height The height of the image. Defaults to `480`. * @param randomize Whether to randomize the image or not. Defaults to `false`. * * @example * faker.image.people() // 'http://loremflickr.com/640/480/people' * faker.image.people(1234, 2345) // 'http://loremflickr.com/1234/2345/people' * faker.image.people(1234, 2345, true) // 'http://loremflickr.com/1234/2345/people?56789' */ people(width?: number, height?: number, randomize?: boolean): string; /** * Generates a random nature image url. * * @param width The width of the image. Defaults to `640`. * @param height The height of the image. Defaults to `480`. * @param randomize Whether to randomize the image or not. Defaults to `false`. * * @example * faker.image.nature() // 'http://loremflickr.com/640/480/nature' * faker.image.nature(1234, 2345) // 'http://loremflickr.com/1234/2345/nature' * faker.image.nature(1234, 2345, true) // 'http://loremflickr.com/1234/2345/nature?56789' */ nature(width?: number, height?: number, randomize?: boolean): string; /** * Generates a random sports image url. * * @param width The width of the image. Defaults to `640`. * @param height The height of the image. Defaults to `480`. * @param randomize Whether to randomize the image or not. Defaults to `false`. * * @example * faker.image.sports() // 'http://loremflickr.com/640/480/sports' * faker.image.sports(1234, 2345) // 'http://loremflickr.com/1234/2345/sports' * faker.image.sports(1234, 2345, true) // 'http://loremflickr.com/1234/2345/sports?56789' */ sports(width?: number, height?: number, randomize?: boolean): string; /** * Generates a random technics image url. * * @param width The width of the image. Defaults to `640`. * @param height The height of the image. Defaults to `480`. * @param randomize Whether to randomize the image or not. Defaults to `false`. * * @example * faker.image.technics() // 'http://loremflickr.com/640/480/technics' * faker.image.technics(1234, 2345) // 'http://loremflickr.com/1234/2345/technics' * faker.image.technics(1234, 2345, true) // 'http://loremflickr.com/1234/2345/technics?56789' */ technics(width?: number, height?: number, randomize?: boolean): string; /** * Generates a random transport image url. * * @param width The width of the image. Defaults to `640`. * @param height The height of the image. Defaults to `480`. * @param randomize Whether to randomize the image or not. Defaults to `false`. * * @example * faker.image.transport() // 'http://loremflickr.com/640/480/transport' * faker.image.transport(1234, 2345) // 'http://loremflickr.com/1234/2345/transport' * faker.image.transport(1234, 2345, true) // 'http://loremflickr.com/1234/2345/transport?56789' */ transport(width?: number, height?: number, randomize?: boolean): string; /** * Generates a random data uri containing an svg image. * * @param width The width of the image. Defaults to `640`. * @param height The height of the image. Defaults to `480`. * @param color The color to use. Defaults to `grey`. * * @example * faker.image.dataUri() // 'data:image/svg+xml;charset=UTF-8,%3Csvg%20xmlns%3D%22http...' */ dataUri(width?: number, height?: number, color?: string): string; }