Cached relationships are created by using the 'includes' parameter on search requests or other functions that support it. For every type included in the parameter, relationships of that type will be replaced by the actual object. The object will still be represented by a Relationship object, but the resolve method will return instantly with the cached data. Each resulting object will have no further relationships of its own.
Private Optional cachedThe MangaDex UUID of the object this relationship refers to
Optional relatedIf the relationship is between two manga, how are they related?
What type of object is this a relationship to
Static Private typeStatic Private typeThis will automatically fetch the associated object that this relationship refers to. In other words, it wil call Manga.get(id), Chapter.get(id), etc with the information stored in this relationship instance. If this relationship is cached, then the resulting object will not have any relationships of its own.
Static convertInternal
This will search through a relationship response from MangaDex and convert any relationships of a specific type into relationship objects.
Static getStatic lockStatic registerInternal
This function is used to resolved circular references, and should only be used in base.ts. Specifically, it pairs a relationship type to its associated class.
Static resolveThis will resolve an array of relationships, returning another array in the same order.
An array of relationships of the same type
Generated using TypeDoc
Represents a relationship from one MangaDex object to another such as a manga, author, etc via its id.