@book000/pixivts
Version:
pixiv Unofficial API Library for TypeScript
96 lines • 2.46 kB
TypeScript
import { BaseSimpleCheck, CheckFunctions } from '../checks';
/**
* 作品の画像URL群
*
* 単一画像の場合、オリジナル画像へは {@link MetaSinglePage.original_image_url} から取得
*
* 画像へのアクセスは適切なリファラを付与する必要がある
*/
export interface ImageUrls {
/** 360x360 */
square_medium: string;
/** 長辺が最大 540px */
medium: string;
/** 横幅が最大 600px, 縦幅が最大 1200px */
large: string;
/**
* オリジナル画像
*
* {@link MetaPages.image_urls} の場合のみ存在？
*/
original?: string;
}
export declare class ImageUrlsCheck extends BaseSimpleCheck<ImageUrls> {
checks(): CheckFunctions<ImageUrls>;
}
/**
* プロフィール画像URL群
*/
export interface ProfileImageUrls {
/** 中サイズ */
medium: string;
}
/**
* ユーザー情報
*/
export interface PixivUser {
/** ユーザー内部 ID */
id: number;
/** ユーザー名 */
name: string;
/** pixiv ID (URLに使用) */
account: string;
/** プロフィール画像URL群 */
profile_image_urls: ProfileImageUrls;
/** フォローしているかどうか */
is_followed?: boolean;
/** アクセスをブロックしているユーザーであるか */
is_access_blocking_user?: boolean;
}
export declare class PixivUserCheck extends BaseSimpleCheck<PixivUser> {
checks(): CheckFunctions<PixivUser>;
}
/**
* タグ情報
*/
export interface Tag {
/** タグ名 */
name: string;
/** 翻訳済みタグ名 */
translated_name: string | null;
/** 投稿者によって追加されたタグかどうか */
added_by_uploaded_user?: boolean;
}
export declare class TagCheck extends BaseSimpleCheck<Tag> {
checks(): CheckFunctions<Tag>;
}
/**
* シリーズ情報
*/
export interface Series {
/** シリーズ ID */
id: number;
/** シリーズ名 */
title: string;
}
export declare class SeriesCheck extends BaseSimpleCheck<Series> {
checks(): CheckFunctions<Series>;
}
export interface PrivacyPolicy {
/**
* バージョン
*/
version?: string;
/**
* メッセージ
*/
message?: string;
/**
* URL
*/
url?: string;
}
export declare class PrivacyPolicyCheck extends BaseSimpleCheck<PrivacyPolicy> {
checks(): CheckFunctions<PrivacyPolicy>;
}
//# sourceMappingURL=pixiv-common.d.ts.map