Video Type

Access video type classification data from the Comic Vine API. Official API docs: /video_type | /video_types

const videoType = client.videoType;

Methods

`retrieve(id, options?)`

Parameters:

Name	Type	Required	Description
`id`	`number`	Yes	The unique ID of the video type
`options.fieldList`	`string[]`	No	Only return the specified fields

Returns: Promise<VideoTypeDetails>

const videoType = await client.videoType.retrieve(12345);

// With field selection
const videoType = await client.videoType.retrieve(12345, {
  fieldList: ['id', 'name', 'deck'],
});

interface VideoTypeDetails {
  /** URL pointing to the video_type detail resource. */
  apiDetailUrl: string;
  /** Brief summary of the video_type. */
  deck: null | string;
  /** Unique ID of the video_type. */
  id: number;
  /** Name of the video_type. */
  name: string;
  /** URL pointing to the video_type on Giant Bomb. */
  siteDetailUrl: string;
}

`list(options?)`

Parameters:

Name	Type	Required	Description
`options.fieldList`	`string[]`	No	Only return the specified fields
`options.limit`	`number`	No	Number of results to return (default: 100)
`options.offset`	`number`	No	Number of results to skip
`options.sort`	`SortOption`	No	Sort field and direction
`options.filter`	`object`	No	Filter results by field values

Returns: Promise<PageData> & AsyncIterable<VideoTypeListItem>

const videoTypes = await client.videoType.list();

// With auto pagination
for await (const videoType of client.videoType.list()) {
  console.log(videoType.name);
}

interface VideoTypeListItem {
  /** URL pointing to the video_type detail resource. */
  apiDetailUrl: string;
  /** Brief summary of the video_type. */
  deck: null | string;
  /** Unique ID of the video_type. */
  id: number;
  /** Name of the video_type. */
  name: string;
  /** URL pointing to the video_type on Giant Bomb. */
  siteDetailUrl: string;
}