Issue

Access comic book issue data from the Comic Vine API. Official API docs: /issue | /issues

const issue = client.issue;

Methods

`retrieve(id, options?)`

Parameters:

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

Returns: Promise<IssueDetails>

const issue = await client.issue.retrieve(6);

// With field selection
const issue = await client.issue.retrieve(6, {
  fieldList: ['id', 'name', 'issueNumber', 'coverDate'],
});

interface IssueDetails {
  /** List of aliases the issue is known by. A \n (newline) seperates each alias. */
  aliases: null | string;
  /** URL pointing to the issue detail resource. */
  apiDetailUrl: string;
  associatedImages: Array<AssociatedImage>;
  characterCredits: Array<SiteResource>;
  characterDiedIn: Array<SiteResource>;
  conceptCredits: Array<SiteResource>;
  /** The publish date printed on the cover of an issue. */
  coverDate: Date;
  /** Date the issue was added to Comic Vine. */
  dateAdded: Date;
  /** Date the issue was last updated on Comic Vine. */
  dateLastUpdated: Date;
  /** Brief summary of the issue. */
  deck: null | string;
  /** Description of the issue. */
  description: null | string;
  /** A list of characters in which this issue is the first appearance of the character. */
  firstAppearanceCharacters: null | unknown;
  /** A list of concepts in which this issue is the first appearance of the concept. */
  firstAppearanceConcepts: null | unknown;
  /** A list of locations in which this issue is the first appearance of the location. */
  firstAppearanceLocations: null | unknown;
  /** A list of things in which this issue is the first appearance of the object. */
  firstAppearanceObjects: null | unknown;
  /** A list of storyarcs in which this issue is the first appearance of the story arc. */
  firstAppearanceStoryarcs: null | unknown;
  /** A list of teams in which this issue is the first appearance of the team. */
  firstAppearanceTeams: null | unknown;
  hasStaffReview: null | false | SiteResource;
  /** Unique ID of the issue. */
  id: number;
  /** Main image of the issue. */
  image: Image;
  /** The number assigned to the issue within the volume set. */
  issueNumber: string;
  locationCredits: Array<SiteResource>;
  /** Name of the issue. */
  name: null | string;
  objectCredits: Array<SiteResource>;
  personCredits: Array<PersonCreditSiteResource>;
  /** URL pointing to the issue on Giant Bomb. */
  siteDetailUrl: string;
  /** The date the issue was first sold in stores. */
  storeDate: Date | null;
  storyArcCredits: Array<SiteResource>;
  teamCredits: Array<SiteResource>;
  teamDisbandedIn: Array<SiteResource>;
  /** The volume this issue is a part of. */
  volume: SiteResource;
}

`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<IssueListItem>

const issues = await client.issue.list({
  filter: { volume: 796 },
  limit: 50,
});

// With auto pagination
for await (const issue of client.issue.list({ filter: { volume: 796 } })) {
  console.log(issue.name);
}

interface IssueListItem {
  /** List of aliases the issue is known by. A \n (newline) seperates each alias. */
  aliases: null | string;
  /** URL pointing to the issue detail resource. */
  apiDetailUrl: string;
  associatedImages: Array<AssociatedImage>;
  /** The publish date printed on the cover of an issue. */
  coverDate: Date;
  /** Date the issue was added to Comic Vine. */
  dateAdded: Date;
  /** Date the issue was last updated on Comic Vine. */
  dateLastUpdated: Date;
  /** Brief summary of the issue. */
  deck: null | unknown;
  /** Description of the issue. */
  description: null | string;
  hasStaffReview: null | false | SiteResource;
  /** Unique ID of the issue. */
  id: number;
  /** Main image of the issue. */
  image: Image;
  /** The number assigned to the issue within the volume set. */
  issueNumber: string;
  /** Name of the issue. */
  name: null | string;
  /** URL pointing to the issue on Giant Bomb. */
  siteDetailUrl: string;
  /** The date the issue was first sold in stores. */
  storeDate: Date | null;
  /** The volume this issue is a part of. */
  volume: SiteResource;
}