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

Usage

import * as scrapboxUrlCustomizer from "https://raw.githubusercontent.com/takker99/scrapbox-url-customizer/0.2.2/deps/scrapbox-rest.ts";

§Classes

UnexpectedResponseError

想定されない応答が帰ってきたときに投げる例外

§Variables

cookie

HTTP headerのCookieに入れる文字列を作る

exportPages

projectの全ページをエクスポートする

getCodeBlock

指定したコードブロック中のテキストを取得する

getCodeBlocks

他のページ(または取得済みの行データ)のコードブロックを全て取得する

getCSRFToken

CSRF tokenを取得する

getGyazoToken

Gyazo OAuth uploadで使うaccess tokenを取得する

getLinks

指定したprojectのリンクデータを取得する

getPage

指定したページのJSONデータを取得する

getProfile

get user profile

getProject

get the project information

getSnapshots

get page snapshots

getTable

指定したテーブルをCSV形式で得る

getTweetInfo

指定したTweetの情報を取得する

getWebPageTitle

指定したURLのweb pageのtitleをscrapboxのserver経由で取得する

importPages

projectにページをインポートする

listPages

指定したprojectのページを一覧する

listProjects

list the projects' information

makeError

失敗した要求からエラー情報を取り出す

readLinks

指定したprojectの全てのリンクデータを取得し、一つづつ返す

readLinksBulk

指定したprojectの全てのリンクデータを取得する

readSnapshots

指定したページの全てのsnapshotsを取得し、一つづつ返す

readSnapshotsBulk

指定したページのsnapshotsを、responseに入っている塊ごとに全て返す

replaceLinks

指定したproject内の全てのリンクを書き換える

searchForJoinedProjects

search for joined projects

searchForPages

search a project for pages

searchForWatchList

search for watch list

setDefaults

BaseOptionsの既定値を埋める

uploadToGCS

任意のファイルをscrapbox.ioにuploadする

§Interfaces

BackupData

project backup data

BackupedPage

backupされるページデータ

BadRequestError

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

BaseLine

scrapboxの行のメタデータ

BaseOptions

全てのREST APIに共通するopitons

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したときのページデータ

ExportInit

exportPagesの認証情報

ExtendedOptions

BaseeOptionsにCSRF情報を入れたもの

FileCapacityError

容量を使い切ったときに発生するerror

GCSError

Google Cloud Storage XML APIのerror

GCSFile

uploadしたファイルのメタデータ

GetCodeBlock
GetCodeBlocksFilter

getCodeBlocks()に渡すfilter

GetGyazoTokenOptions
GetLinksOptions
GetPage
GetPageOption

Options for getPage()

GetProject
GetSnapshotsOptions
GetTable
GuestUser
ImageChange

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

ImportedData

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

ImportedLightPage

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

ImportedLine

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

ImportedPage

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

InsertChange

行を新規作成する変更

InvalidFollowingIdError

不正なfollowingIdを渡されたときに発生するエラー

InvalidPageSnapshotIdError

不正なfollowingIdを渡されたときに発生するエラー

InvalidURLError

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

LinksChange

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

ListPages
ListPagesOption

Options for listPages()

ListProjects
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

TinyCodeBlock

pull()から取れる情報で構成したコードブロックの最低限の情報

TitleChange

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

TooLongURIError
TweetInfo

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

UpdateChange

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

User

user information

UserInfo

user detailed information

§Type Aliases

Change

ページの変更内容

CommitId

the commit id

Fetch

networkからdataをとってくる処理

LineId

the line id

PageId

the page id

ProjectId

the project id

Result

正常値と異常値を格納する型

StringLc

the formatted string

UnixTime

UNIX time

UserId

the user id

UserResponse

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