Skip to content

Variable: highlightSchema ​

ts
const highlightSchema: ZodObject<{
  id: ZodString;
  items: ZodOptional<ZodArray<ZodObject<{
     caption: ZodOptional<ZodNullable<ZodObject<{
        text: ZodOptional<...>;
     }, $loose>>>;
     code: ZodOptional<ZodString>;
     comment_count: ZodOptional<ZodNullable<ZodNumber>>;
     id: ZodOptional<ZodString>;
     image_versions2: ZodOptional<ZodObject<{
        candidates: ZodOptional<ZodArray<...>>;
     }, $loose>>;
     like_count: ZodOptional<ZodNullable<ZodNumber>>;
     media_type: ZodOptional<ZodNumber>;
     pk: ZodOptional<ZodCoercedString<unknown>>;
     taken_at: ZodOptional<ZodNumber>;
     user: ZodOptional<ZodObject<{
        biography: ZodOptional<ZodString>;
        external_url: ZodOptional<ZodNullable<...>>;
        follower_count: ZodOptional<ZodNullable<...>>;
        following_count: ZodOptional<ZodNullable<...>>;
        full_name: ZodOptional<ZodString>;
        is_private: ZodOptional<ZodBoolean>;
        is_verified: ZodOptional<ZodBoolean>;
        media_count: ZodOptional<ZodNullable<...>>;
        pk: ZodOptional<ZodCoercedString<...>>;
        profile_pic_url: ZodOptional<ZodNullable<...>>;
        username: ZodOptional<ZodString>;
     }, $loose>>;
     usertags: ZodOptional<ZodNullable<ZodObject<{
        in: ZodOptional<...>;
     }, $loose>>>;
     video_versions: ZodOptional<ZodNullable<ZodArray<ZodObject<{
        height: ...;
        url: ...;
        width: ...;
     }, $loose>>>>;
  }, $loose>>>;
  media_count: ZodOptional<ZodNullable<ZodNumber>>;
  title: ZodOptional<ZodString>;
  user: ZodOptional<ZodObject<{
     biography: ZodOptional<ZodString>;
     external_url: ZodOptional<ZodNullable<ZodString>>;
     follower_count: ZodOptional<ZodNullable<ZodNumber>>;
     following_count: ZodOptional<ZodNullable<ZodNumber>>;
     full_name: ZodOptional<ZodString>;
     is_private: ZodOptional<ZodBoolean>;
     is_verified: ZodOptional<ZodBoolean>;
     media_count: ZodOptional<ZodNullable<ZodNumber>>;
     pk: ZodOptional<ZodCoercedString<unknown>>;
     profile_pic_url: ZodOptional<ZodNullable<ZodString>>;
     username: ZodOptional<ZodString>;
  }, $loose>>;
}, $loose>;

A story highlight. id is the app's form, highlight:123. The functions that take a highlight accept that or the bare 123. A highlight read on its own also carries its stories under items. One listed on a profile does not.

MIT License. Not affiliated with, endorsed or sponsored by Meta or Instagram.