Skip to content

types.md

Latest commit

 

History

History
263 lines (173 loc) · 10.9 KB

types.md

File metadata and controls

263 lines (173 loc) · 10.9 KB
Raw

instagram-private-api / types

Module: types

Table of contents

Interfaces

Type aliases

Variables

Type aliases

DirectThreadBroadcastOptions

Ƭ DirectThreadBroadcastOptions: DirectTreadBroadcastBaseOptions & XOR<ExistingThreadOptions, CreateThreadOptions>

Defined in

src/types/direct-thread.broadcast.options.ts:18

IgAppModule

Ƭ IgAppModule: "feed_timeline" | "newsfeed" | "profile" | "media_view_profile" | "video_view_profile" | "photo_view_profile" | "followers" | "following" | "self_followers" | "self_following" | "comment_likers" | "comment_owner" | "feed_contextual_post" | "feed_contextual_hashtag" | "feed_contextual_location" | "feed_contextual_newsfeed_multi_media_liked" | "likers_likers_media_view_profile" | "likers_likers_photo_view_profile" | "likers_likers_video_view_profile" | "self_likers_self_likers_media_view_profile" | "self_likers_self_likers_photo_view_profile" | "self_likers_self_likers_video_view_profile" | "story_camera_music_overlay_post_capture" | "story_camera_music_overlay_pre_capture" | "story_viewer_profile" | "story_viewer_default" | "find_friends_contacts" | "explore_people" | "igtv_feed_timeline" | string

Defined in

src/types/common.types.ts:3

IgResponse

Ƭ IgResponse<Body>: Pick<Response, Exclude<keyof Response, "body">> & { body: Body }

Type parameters

Name
Body

Defined in

src/types/common.types.ts:35

InsightsFriendlyName

Ƭ InsightsFriendlyName: "IgInsightsAccountInsightsSurfaceQuery" | "IgInsightsAccountInsightsWithTabsQuery" | "IgInsightsPostGridSurfaceQuery" | "IgInsightsPostInsightsQuery" | "IgInsightsStoryInsightsAppQuery" | string

Defined in

src/types/graphql-request.options.ts:8

InsightsSurface

Ƭ InsightsSurface: "account" | "post" | "story" | string

Defined in

src/types/graphql-request.options.ts:15

LikeModuleInfoOption

Ƭ LikeModuleInfoOption: FeedTimeline | FeedContextualHashtag | FeedContextualLocation | Profile | MediaViewProfile | VideoViewProfile | PhotoViewProfile & { [x: string]: any; }

Defined in

src/types/media.like.options.ts:36

LikeRequestOptions

Ƭ LikeRequestOptions: LikeOrUnlikeBaseOptions & { d: 1 | 0 }

Defined in

src/types/media.like.options.ts:51

MediaLikeOrUnlikeOptions

Ƭ MediaLikeOrUnlikeOptions: LikeOrUnlikeBaseOptions & { action: "like" | "unlike" ; d?: 1 | 0 }

Defined in

src/types/media.like.options.ts:59

SegmentDivider

Ƭ SegmentDivider: (options: { buffer: Buffer ; client: IgApiClient }) => Buffer[]

Type declaration

▸ (options): Buffer[]

Parameters
Name Type
options Object
options.buffer Buffer
options.client IgApiClient
Returns

Buffer[]

Defined in

src/types/upload.video.options.ts:38

SetBestiesInput

Ƭ SetBestiesInput: Object

Type declaration

Name Type
add? (string | number)[]
remove? (string | number)[]

Defined in

src/types/set-besties.input.ts:1

StoryServiceInput

Ƭ StoryServiceInput: StoryServiceSeenInputItems[] | StoryServiceSeenInputReels

Defined in

src/types/stories.types.ts:13

TimelineFeedReason

Ƭ TimelineFeedReason: "pagination" | "pull_to_refresh" | "warm_start_fetch" | "cold_start_fetch"

Defined in

src/types/timeline-feed.types.ts:1

UnlikeRequestOptions

Ƭ UnlikeRequestOptions: LikeOrUnlikeBaseOptions & { d?: 0 }

Defined in

src/types/media.like.options.ts:55

Variables

SEGMENT_DIVIDERS

• Const SEGMENT_DIVIDERS: Object

Type declaration

Name Type
sectionSize (sectionSize: any) => SegmentDivider
totalSections (numSections: any) => SegmentDivider

Defined in

src/types/upload.video.options.ts:54