docs unclear: faker.unsplash is not defined

[carlos-nexans]

Describe the bug

faker.unsplash is not defined whereas the docs allows to use it (reference)

Reproduction

Minimal code to reproduce:

import faker from '@faker-js/faker'
faker.unsplash.technology()

This code shows a typescript warning

Property 'unsplash' does not exist on type 'Faker'. ts(2339)

When it's run it throws this error

TypeError: Cannot read properties of undefined (reading 'technology')

Additional Info

I found that unsplash is accesible via the image property

import faker from '@faker-js/faker'
faker.image.unsplash.technology()

We should either update the documentation or add unsplash to the Faker top level methods. The first option feels more natural to me. I would like to contribute introducing the fix if needed.

[ST-DDT]

It looks like the docs generation does not properly filter elements that arent directly available via faker.

We will fix that. Thanks for bringing this to our attention.

[ST-DDT]

If you are willing to contribute, then I can assign this issue to you.
The relevant code is in scripts/apidoc.ts.

faker/scripts/apidoc.ts

Line 81 in 22a8cbc

.getChildrenByKind(TypeDoc.ReflectionKind.Class);

Please note that I'm currently trying to rewrite the code a bit to use vue components so please dont refactor the code unless necessary

[Shinigami92]

@cdgn-coding While we are fixing the docs, just use https://stackblitz.com/edit/typescript-wsqtmx?file=index.ts in the meantime

import { faker } from '@faker-js/faker';

faker.image.unsplash.avatar();

[carlos-nexans]

I started to use the methods below faker.image.unsplash and it seems to work. Nevertheless, I found that these methods always return the same URL https://source.unsplash.com/category/{category}/640x480, and Unsplash has the responsibility to give randomized images under the category. That doesn't seem to work as intuitively expected.

This example renders images using faker.image.unsplash.technology(), and it's rare to find any that is related to technology. Whereas Unsplash has many more technology-related examples. Do you think we can also improve this behavior?

[ST-DDT]

I started to use the methods below faker.image.unsplash and it seems to work. Nevertheless, I found that these methods always return the same URL https://source.unsplash.com/category/{category}/640x480, and Unsplash has the responsibility to give randomized images under the category. That doesn't seem to work as intuitively expected.

This example renders images using faker.image.unsplash.technology(), and it's rare to find any that is related to technology. Whereas Unsplash has many more technology-related examples. Do you think we can also improve this behavior?

Yes, but any kind of bugfix of existing code is scheduled for 6.1 or later.
(We first want to have a stable foundation before touching anything.)

[Shinigami92]

Due to following code works, I will close this issue.

import { faker } from "@faker-js/faker";

faker.image.unsplash.technology();

Please open new dedicated issues for anything that was unrelated to this issue.

[ST-DDT]

This is a bug in our documentation, that needs to be fixed.

[airtonix]

Unsplash is deprecating the above urls in two stages:

• stage one: source.unsplash.com only gives out random images from a extremely limited set of photos
• stage two: source.unsplash.com will 404

[ST-DDT]

We deprecated the unsplash apis for removal already.

faker/src/modules/image/index.ts

Lines 12 to 15 in 2e6b136

	/**
	* @deprecated Use `faker.image` instead.
	*/
	readonly unsplash: Unsplash;