Skip to main content

Built and signed on GitHub Actions

Type definitions for Cosense

This package works with Deno, BrowsersIt is unknown whether this package works with Cloudflare Workers, Node.js, Bun
It is unknown whether this package works with Cloudflare Workers
It is unknown whether this package works with Node.js
This package works with Deno
It is unknown whether this package works with Bun
This package works with Browsers
JSR Score
100%
Published
2 months ago (0.10.1)

type definitions for Cosense REST API responses

Interfaces

I
BackupData

project backup data

I
BackupedPage

backupされるページデータ

I
BadRequestError

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

I
BaseLine

scrapboxの行のメタデータ

I
BasePage

basic information about a page

I
ChangeLine
No documentation available
I
Commit

Scrapboxのページの編集commit

I
CommitsResponse

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

I
DeleteChange

既存の行を削除する変更

I
DescriptionsChange

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

I
ErrorLike

Scrapbox REST APIが返すエラーの型

I
ExportedData
No documentation available
I
ExportedPage

exportしたときのページデータ

I
FileCapacityError

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

I
FileSearchResult

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

I
FoundPage

/api/pages/:projectname/search/titles で見つかったページ

I
FoundPageByFile

/api/pages/:projectname/search/files で見つかったページ

I
FoundProject

/api/projects/search/query や /api/projects/search/watch-list で見つかったproject

I
GCSError

Google Cloud Storage XML APIのerror

I
GuestUser
No documentation available
I
ImageChange

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

I
ImportedLightPage

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

I
ImportedLine

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

I
ImportedPage

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

I
InfoboxResult
No documentation available
I
InsertChange

行を新規作成する変更

I
InvalidFollowingIdError

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

I
InvalidURLError

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

I
LinksChange

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

I
MemberProject

project information which is joined

I
MemberUser
No documentation available
I
NewLine
No documentation available
I
NoQueryError

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

I
NotFoundError

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

I
NotLoggedInError

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

I
NotMemberError

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

I
NotMemberProject

project information which isn't joined

I
NotPrivilegeError

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

I
Page

page information

I
PageSnapshotList

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

I
PageSnapshotResult

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

I
PageWithSnapshot
No documentation available
I
PinChange

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

I
Project

project information

I
ProjectRelatedPage

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

I
ProjectResponse

the response type of /api/projects

I
ProjectSearchResult

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

I
RelatedPage

関連ページのメタデータ

I
RelatedPages
No documentation available
I
SearchQuery

検索クエリ

I
SearchResult

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

I
SessionError

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

I
Snapshot

a page snapshot

I
SnapshotTimestamp
No documentation available
I
TitleChange

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

I
TweetInfo

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

I
UpdateChange

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

I
User

user information

I
UserInfo

user detailed information

Type Aliases

T
Change

ページの変更内容

T
CommitId

the commit id

T
LineId

the line id

T
PageId

the page id

T
ProjectId

the project id

T
StringLc

the formatted string

T
UnixTime

UNIX time

T
UserId

the user id

Add Package

deno add jsr:@cosense/types

Import symbol

import * as mod from "@cosense/types/rest";

---- OR ----

Import directly with a jsr specifier

import * as mod from "jsr:@cosense/types/rest";

Add Package

npx jsr add @cosense/types

Import symbol

import * as mod from "@cosense/types/rest";

Add Package

yarn dlx jsr add @cosense/types

Import symbol

import * as mod from "@cosense/types/rest";

Add Package

pnpm dlx jsr add @cosense/types

Import symbol

import * as mod from "@cosense/types/rest";

Add Package

bunx jsr add @cosense/types

Import symbol

import * as mod from "@cosense/types/rest";