Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

Usage

import * as types from "https://raw.githubusercontent.com/scrapbox-jp/types/0.3.5/rest.ts";

§Interfaces

BadRequestError

URL先ページから正常な応答が返ってこなかったときのエラー

BaseLine

scrapboxの行のメタデータ

BasePage

basic information about a page

ChangeLine
Commit

Scrapboxのページの編集commit

CommitsResponse

the response type of /api/commits/:projectname/:pageid

DeleteChange

既存の行を削除する変更

DescriptionsChange

ページのサムネイル本文が変更されると発生する

ErrorLike

Scrapbox REST APIが返すエラーの型

ExportedData
ExportedPage

exportもしくはbackupをとったときのページデータ

GuestUser
ImageChange

ページのサムネイルが変更されると発生する

ImportedData

JSON data for importing by https://scrapbox.io/api/page-data/import/:projectname.json

ImportedLightPage

メタデータ無しインポート用ページデータ

ImportedLine

インポート用メタデータ付き行データ

ImportedPage

メタデータ付きインポート用ページデータ

InsertChange

行を新規作成する変更

InvalidURLError

不正なURLを渡したときに返ってくるエラー

LinksChange

ページ中のリンクが変更されると発生する

MemberProject

project information which is joined

MemberUser
NewLine
NoQueryError

検索文字列を渡さないと出てくるエラー

NotFoundError

指定したprojectやpageが見つからないときに発生するエラー

NotLoggedInError

Loginが必要なAPIをloginせずに叩いたときに発生するエラー

NotMemberError

参加していないprivate projectに対してAPIを叩いたときに発生するエラー

NotMemberProject

project information which isn't joined

NotPrivilegeError

owner/admin権限が不足しているときに発生するエラー

Page

page information

PageList

the response type of https://scrpabox.io/api/pages/:projectname

PageSnapshot

the response type of /api/page-snapshots/:projectname/:pageid

PinChange

ページのピンの状態が変更されると発生する

Project

project information

ProjectRelatedPage

外部プロジェクトの関連ページ

ProjectResponse

the response type of /api/projects

ProjectSearchResult

the response type of /api/projects/search/query and /api/projects/search/watch-list

RelatedPage

関連ページのメタデータ

RelatedPages
SearchedTitle

the response type of https://scrapbox.io/api/pages/:projectname/search/titles

SearchQuery

検索クエリ

SearchResult

the response type of /api/pages/:projectname/search/titles

SessionError

CSRF tokenが不正なときに発生するエラー

Snapshot

a page snapshot

TitleChange

ページのタイトルが変更されると発生する

TweetInfo

the response type of /api/embed-text/twitter

UpdateChange

既存の行を書き換える変更

User

user information

UserInfo

user detailed information

§Type Aliases

Change

ページの変更内容

CommitId

the commit id

LineId

the line id

PageId

the page id

ProjectId

the project id

StringLc

the formatted string

UnixTime

UNIX time

UserId

the user id

UserResponse

the response type of https://scrapbox.io/api/users/me