Skip to content

Latest commit

 

History

History
281 lines (154 loc) · 6.42 KB

_types_.imodinfo.md

File metadata and controls

281 lines (154 loc) · 6.42 KB
Raw

@nexusmods/nexus-api › Globals › "types" › IModInfo

Interface: IModInfo

Details about a mod

Hierarchy

Index

Properties

Properties

allow_rating

• allow_rating: boolean

Defined in src/types.ts:139

whether this mod allows endorsements

author

• author: string

Defined in src/types.ts:92

Author of the mod

available

• available: boolean

Defined in src/types.ts:115

whether the mod is currently available/visible to users If a mod isn't available the api returns very limited information, essentially hiding all textual info that could contain offensive content but certain "maintenance" info is still provided.

category_id

• category_id: number

Defined in src/types.ts:67

id of the category

contains_adult_content

• contains_adult_content: boolean

Defined in src/types.ts:71

whether this mod is tagged as adult

created_time

• created_time: string

Defined in src/types.ts:127

readable time of when the mod was created

created_timestamp

• created_timestamp: number

Defined in src/types.ts:123

unix timestamp of when the mod was created

Optional description

• description? : string

Defined in src/types.ts:84

long description (bbcode)

domain_name

• domain_name: string

Defined in src/types.ts:63

domain name (as used in urls and as the game id in all other requests)

Optional endorsement

• endorsement? : object

Defined in src/types.ts:147

obsolete - will be removed in the near future

Type declaration:

endorsement_count

• endorsement_count: number

Defined in src/types.ts:143

endorsement count

game_id

• game_id: number

Defined in src/types.ts:59

internal id of the game this mod belongs to

mod_id

• mod_id: number

Defined in src/types.ts:55

id of this mod (should be the same you queried for)

Optional name

• name? : string

Defined in src/types.ts:76

Name of the mod (not present if the file is under moderation)

Optional picture_url

• picture_url? : string

Defined in src/types.ts:119

url of the primary screenshot

status

• status: ModStatus

Defined in src/types.ts:108

current status of the mod

Optional summary

• summary? : string

Defined in src/types.ts:80

short description

updated_time

• updated_time: string

Defined in src/types.ts:135

readable time of when the mod was updated

updated_timestamp

• updated_timestamp: number

Defined in src/types.ts:131

unix timestamp of when the mod was updated

uploaded_by

• uploaded_by: string

Defined in src/types.ts:100

name of the user who uploaded this mod

uploaded_users_profile_url

• uploaded_users_profile_url: string

Defined in src/types.ts:104

url of the profile image of the uploader

user

• user: IUser

Defined in src/types.ts:96

more detailed info about the author

version

• version: string

Defined in src/types.ts:88

mod version