Class File

A data container for file data

class
extends: { HackerAPI.Base }

Hierarchy

Base
- File

Index

Constructors

constructor

Properties

Accessors

Type

Methods

Constructors

constructor

new File(__namedParameters: { createdAt: undefined | Date; created_at: undefined | Date; eventSlug: undefined | string; event_slug: undefined | string; expiry: undefined | Date; id: undefined | number; mimeType: undefined | string; mime_type: undefined | string; name: undefined | string; size: undefined | number; type: undefined | string | Type; updatedAt: undefined | Date; updated_at: undefined | Date; url: undefined | string; userId: undefined | number; userName: undefined | string; user_id: undefined | number; user_name: undefined | string }): File

Overrides Base.constructor
- Defined in file/file.ts:37
Creates a new instance of a file

constructor

Parameters
- __namedParameters: { createdAt: undefined | Date; created_at: undefined | Date; eventSlug: undefined | string; event_slug: undefined | string; expiry: undefined | Date; id: undefined | number; mimeType: undefined | string; mime_type: undefined | string; name: undefined | string; size: undefined | number; type: undefined | string | Type; updatedAt: undefined | Date; updated_at: undefined | Date; url: undefined | string; userId: undefined | number; userName: undefined | string; user_id: undefined | number; user_name: undefined | string }
  - createdAt: undefined | Date
  - created_at: undefined | Date
  - eventSlug: undefined | string
  - event_slug: undefined | string
  - expiry: undefined | Date
  - id: undefined | number
  - mimeType: undefined | string
  - mime_type: undefined | string
  - name: undefined | string
  - size: undefined | number
  - type: undefined | string | Type
  - updatedAt: undefined | Date
  - updated_at: undefined | Date
  - url: undefined | string
  - userId: undefined | number
  - userName: undefined | string
  - user_id: undefined | number
  - user_name: undefined | string
Returns File

Properties

Optional createdAt

createdAt: Date

Optional eventSlug

eventSlug: undefined | string

Optional expiry

expiry: Date

Optional id

id: undefined | number

Optional mimeType

mimeType: undefined | string

Optional name

name: undefined | string

Optional size

size: undefined | number

specialHandlers

specialHandlers: {}

Type declaration

[key: string]: (...args: unknown[]) => [string, undefined | string]
- - (...args: unknown[]): [string, undefined | string]
  - Parameters
    - Rest ...args: unknown[]
    Returns [string, undefined | string]

Optional type

type: string | Type

Optional updatedAt

updatedAt: Date

Optional url

url: undefined | string

Optional userId

userId: undefined | number

Optional userName

userName: undefined | string

Accessors

Static Type

get Type(): Type

- Defined in file/file.ts:35
Returns Type

Methods

toHackerAPIFormat

toHackerAPIFormat(method?: undefined | string): {}

Inherited from Base.toHackerAPIFormat
- Defined in base/base.ts:88
Converts an object to hackerapi object notation

Parameters
- Optional method: undefined | string
Returns {}
- [key: string]: JSONObject

Static dateHandler

dateHandler(key: string, date: string | Date): string[]

Inherited from Base.dateHandler
- Defined in base/base.ts:29
Converts a Javascript date (where only day, month and year are relevant) to a format understood by hackerapi

Parameters
- key: string
- date: string | Date
  
  Doesn't do anything if string
Returns string[]

key: [0], value: [1]

Static dateTimeHandler

dateTimeHandler(key: string, datetime: string | Date): string[]

Inherited from Base.dateTimeHandler
- Defined in base/base.ts:42
Converts Javascript date to a format understood by hackerapi

Parameters
- key: string
- datetime: string | Date
Returns string[]

key: [0], value: [1]

Static doNotSendHandler

doNotSendHandler(key: string, _: any): (undefined | string)[]

Inherited from Base.doNotSendHandler
- Defined in base/base.ts:56
Does not send the field to hackerapi

Parameters
- key: string
- _: any
Returns (undefined | string)[]

key: [0], value: [1]

Static download

download(__namedParameters: { id: number }, token?: undefined | string): Promise<any>

- Defined in file/file.ts:156
Downloads a file

Parameters
- __namedParameters: { id: number }
  - id: number
- Optional token: undefined | string
Returns Promise<any>

Static fetch

fetch(__namedParameters: { id: number }, token?: undefined | string): Promise<{}>

- Defined in file/file.ts:142
Fetches info about a file

Parameters
- __namedParameters: { id: number }
  - id: number
- Optional token: undefined | string
Returns Promise<{}>

Static fetchAllByUserId

fetchAllByUserId(__namedParameters: { id: number }, type?: Type | string | null, __namedParameters: { slug: string | number }, token?: undefined | string): Promise<{}>

- Defined in file/file.ts:175
Fetches all the files belonging to a user, applying the appropriate filters

Parameters
- __namedParameters: { id: number }
  - id: number
- Default value type: Type | string | null = null
- __namedParameters: { slug: string | number }
  - slug: string | number
- Optional token: undefined | string
Returns Promise<{}>

Static renameHandler

renameHandler(renamedKey: string): (Anonymous function)

Inherited from Base.renameHandler
- Defined in base/base.ts:69
HOC for renaming a field before sending it to hackerapi

Parameters
- renamedKey: string
  
  The string to rename the key to
Returns (Anonymous function)

key: [0], value: [1]

Generated using TypeDoc