Skip to main content
Home

@cosense/std@0.31.0
Built and signed on GitHub Actions

UNOFFICIAL standard module for Cosense UserScript

This package works with Node.js, Deno, BrowsersIt is unknown whether this package works with Cloudflare Workers, Bun
It is unknown whether this package works with Cloudflare Workers
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
88%
Published
3 months ago (0.31.0)
I
AbortError
No documentation available
I
AbsoluteLinkNode
No documentation available
f
addTextInputEventListener

Add an event listener to the #text-input element with automatic re-registration

I
AnchorFMNode

Anchor FM Embed Node Represents an Anchor FM podcast episode embed. Extracts the episode ID from Anchor FM URLs to enable podcast episode playback directly within Scrapbox pages.

I
AudioNode

Generic Audio Embed Node Represents a direct audio file embed supporting common formats (mp3, ogg, wav, aac). Used for embedding audio content that isn't from specific platforms like Spotify.

T
AudioURL
No documentation available
I
BaseOptions

Common options shared across all REST API endpoints

f
caret

Retrieves the current cursor position and text selection information

I
CaretInfo

Cursor information contained within the React Component that builds #text-input

f
click

Emulate click event sequences

I
I
CodeBlock

Represents a single code block within a source file

T
CodeBlockError
No documentation available
I
CodeFile

Represents a single source code file with its code blocks

T
CommitMakeHandler

Function type for creating commits to be pushed

f
computeLine
No documentation available
f
connect

connect to websocket

f
cursor
No documentation available
f
cursorLine
No documentation available
f
deleteLines
No documentation available
f
deletePage

Delete a specified page whose title is title from a given project

T
DeletePageOptions
No documentation available
f
disconnect

Disconnect the websocket

f
downBlocks
No documentation available
f
downLines
No documentation available
f
editor
No documentation available
f
encodeTitleURI

Encode a title into a URI-safe format

I
ExportInit

Configuration options for the exportPages function

f
exportPages

Export all pages from a Scrapbox project

T
ExportPagesError
No documentation available
I
ExtendedOptions

Extended options including CSRF token configuration

f
extractCodeFiles

Extract code blocks from scrapbox.Page.lines

f
fetchApiCache

Requests a cache update for the specified API

T
FetchError
No documentation available
I
FileCapacityError

Error that occurs when storage capacity is exceeded

f
findLatestCache

Retrieves the latest response from the cache storage managed by scrapbox.io

I
GCSError

Google Cloud Storage XML API error

I
GCSFile

Metadata for the uploaded file

f
generateCacheName
No documentation available
f
getBaseLine
No documentation available
f
getCachedAt

Get the timestamp when a response was cached by the ServiceWorker

f
getCharDOM
No documentation available
f
getChars
No documentation available
I
GetCodeBlock
No documentation available
v
getCodeBlock

Retrieve text content from a specified code block

f
getCodeBlocks

Extract all code blocks from a Scrapbox page

I
GetCodeBlocksFilter

Filter options for getCodeBlocks()

f
getCSRFToken

Retrieve the CSRF token for secure requests

f
getDOMFromPoint
No documentation available
f
getFormula
No documentation available
f
getGyazoToken

Retrieve an OAuth access token for uploading images to Gyazo

I
GetGyazoTokenOptions
No documentation available
f
getHeadCharDOM
No documentation available
f
getHeadLineDOM
No documentation available
f
getIndentCount
No documentation available
f
getIndentLineCount

Get the number of indented lines under the specified line

f
getIndex
No documentation available
f
getLine
No documentation available
f
getLineCount
No documentation available
f
getLineDOM
No documentation available
f
getLineId

Get the line id from value

f
getLineNo

Get the line number from value

f
getLines
No documentation available
I
GetLinksOptions
No documentation available
I
GetLinksResult
No documentation available
f
getNextLine
No documentation available
I
GetPage
No documentation available
v
getPage

Retrieves JSON data for a specified page

I
GetPageOption

Options for getPage

f
getPrevLine
No documentation available
I
GetProfile
No documentation available
v
getProfile
No documentation available
I
GetProject
No documentation available
v
getProject

Get detailed information about a Scrapbox project

f
getSnapshot

Retrieve a specific version of a page from its snapshot history

I
GetTable
No documentation available
v
getTable

Retrieve a specified table in CSV format from a Scrapbox page

f
getTailCharDOM
No documentation available
f
getTailLineDOM
No documentation available
f
getText
No documentation available
f
getTimestampIds

Retrieves the timestamp IDs for a specific page in a project.

f
getTweetInfo

Retrieve information about a specified Tweet

f
getWebPageTitle

Retrieve the title of a web page through Scrapbox's server

f
goChar

Move cursor to a specific character position

f
goEnd

Move to the end of line

f
goEndWithoutBlank

Move to the last non-whitespace character

f
goHead

Move to the start of line

f
goHeadLine

Move to the start of the first line

f
goHeadWithoutBlank

Move to the start of line excluding indentation

f
goLastLine

Move to the end of the last line

f
goLine

Move to the end of a specified line

f
grid
No documentation available
T
GyazoTokenError
No documentation available
f
holdDown

Emulate long tap event sequence

I
HoldDownOptions
No documentation available
I
HTTPError

Represents an HTTP error response with status code and message.

f
importPages

Import pages into a Scrapbox project

T
ImportPagesError
No documentation available
f
indentBlocks
No documentation available
f
indentLines
No documentation available
f
insertIcon
No documentation available
f
insertLine
No documentation available
f
insertText
No documentation available
f
insertTimestamp
No documentation available
I
InvalidFollowingIdError

Error that occurs when an invalid followingId is provided for pagination

I
InvalidPageSnapshotIdError

Error that occurs when an invalid timestampId is provided to getSnapshot

f
isCharDOM
No documentation available
f
isLineDOM
No documentation available
T
Item
No documentation available
I
ItemGroup
No documentation available
T
KeyName
No documentation available
f
lines
No documentation available
T
LinksError
No documentation available
f
listen

Subscribe to WebSocket events from Scrapbox

T
ListenStreamError
No documentation available
I
ListenStreamOptions
No documentation available
I
ListPages
No documentation available
v
listPages

Lists pages from a specified project

T
ListPagesError
No documentation available
I
I
ListProjects
No documentation available
v
listProjects

List information for multiple Scrapbox projects

T
ListProjectsError
No documentation available
T
MakePatchFn

Function used in patch to generate a patch from the current page state

f
moveBlocks
No documentation available
f
moveDown

Move the cursor down using ArrowDown key

f
moveLeft

Move the cursor left using ArrowLeft key

f
moveLines
No documentation available
f
moveLinesBefore
No documentation available
f
moveRight

Move the cursor right using ArrowRight key

f
moveUp

Move the cursor up using ArrowUp key

I
NetworkError
No documentation available
I
NewPageContent
No documentation available
f
open

Open a page

f
openInTheSameTab

Open a page in the same tab

I
OpenOptions
No documentation available
f
outdentBlocks
No documentation available
f
outdentLines
No documentation available
f
pageCustomButtons
No documentation available
f
pageEditButtons
No documentation available
f
pageEditMenu
No documentation available
T
PageError
No documentation available
f
pageInfoMenu
No documentation available
f
pageMenu
No documentation available
T
PageTransitionContext
No documentation available
I
PageTransitionContextQuery

Represents the state when navigating from search results to a specific page Used to track navigation that originates from a full-text search

f
patch

Modify an entire Scrapbox page by computing and sending only the differences

I
PatchMetadata
No documentation available
T
PatchOptions
No documentation available
f
pin

Pin a Scrapbox page to keep it at the top of the project

f
pinNumber

Calculate a pin number for sorting pinned pages

I
PinOptions
No documentation available
f
popupMenu
No documentation available
I
Position

Position information within the editor

f
prefetch

Executes prefetch operations for specified API URLs

f
press

Dispatches a keyboard event programmatically via JavaScript

T
ProfileError
No documentation available
T
ProjectError
No documentation available
f
push

Push changes to a specific page using WebSocket

T
PushError

Comprehensive error type for push operations

I
PushMetadata

Extended page metadata required for WebSocket operations

I
PushOptions

Configuration options for the push operation

f
pushPageTransition

Registers the page transition state and enables automatic scrolling to the linked content This function stores navigation context in localStorage, which is used to determine where to scroll on the next page load. This is particularly useful for maintaining context when users navigate between related pages or from search results.

f
randomJumpButton
No documentation available
I
Range

Represents a text selection range in the editor

f
readLinksBulk

Retrieve all link data from a specified project in bulk

f
redo
No documentation available
f
removeTextInputEventListener
No documentation available
f
replaceLines
No documentation available
T
ReplaceLinksError
No documentation available
I
RetryError

Error returned when push retry attempts are exhausted

f
revertTitleLc

Convert underscores (_) to single-byte spaces ( )

f
saveApiCache

Saves a response to the REST API cache storage managed by scrapbox.io

T
ScrapboxSocket

A pre-configured Socket type for Scrapbox

f
scrollDown

Scroll one page down using PageDown key

f
scrollHalfDown

Scroll half a page down

f
scrollHalfUp

Scroll half a page up

f
scrollUp

Scroll one page up using PageUp key

f
searchForJoinedProjects

Search across all projects that the user has joined

T
SearchForJoinedProjectsError
No documentation available
f
searchForPages

Search for pages within a specific project

T
SearchForPagesError
No documentation available
f
searchForWatchList

Search within a list of watched projects

T
SearchForWatchListError
No documentation available
f
selections
No documentation available
I
SimpleCodeFile

Interface for specifying code block content and metadata for updates

T
SnapshotError

Union type of all possible errors that can occur when retrieving a page snapshot

T
SnapshotTimestampIdsError

Union type of all possible errors that can occur when retrieving snapshot timestamp IDs

I
SpotifyNode

Spotify Embed Node Represents various types of Spotify content embeds including tracks, artists, playlists, albums, episodes, and shows. Supports all major Spotify content types for rich media integration.

f
statusBar
No documentation available
T
TableError
No documentation available
f
takeCursor
No documentation available
f
takeInternalLines

Get a reference to Scrapbox's internal page content data

f
takeSelection
No documentation available
f
takeStores

Retrieve Scrapbox's internal cursor and selection stores from the DOM

f
textInput
No documentation available
I
TinyCodeBlock

Minimal information about a code block that can be extracted from pull() response

I
TooLongURIError
No documentation available
f
toReadableTitleURI

Convert a title to a URI-safe format while minimizing percent encoding

f
toTitleLc

Convert a string to titleLc format

T
TweetInfoError
No documentation available
f
undo
No documentation available
I
UnexpectedError

Error for unexpected conditions during push operations

f
unpin

Unpin a Scrapbox page, removing it from the pinned list

I
UnPinOptions
No documentation available
f
upBlocks
No documentation available
f
updateCodeBlock

Update the content of a code block in a Scrapbox page

I
UpdateCodeBlockOptions

Configuration options for code block updates

f
updateCodeFile

Update or create code blocks in a Scrapbox page via REST API

I
UpdateCodeFileOptions

Configuration options for updateCodeFile function

f
upLines
No documentation available
T
UploadGCSError
No documentation available
f
uploadToGCS

Upload any file to scrapbox.io

f
useStatusBar

Get a section of the status bar and return functions to manipulate it

I
UseStatusBarResult
No documentation available
I
VideoNode

Generic Video Embed Node Represents a direct video file embed (mp4 or webm formats). Used for embedding video files that aren't from specific platforms like YouTube or Vimeo.

T
VideoURL
No documentation available
I
VimeoNode

Vimeo Embed Node Represents a Vimeo video embed. Extracts and stores the video ID from Vimeo URLs for proper embedding in Scrapbox pages.

T
WebPageTitleError
No documentation available
I
YoutubeListNode

YouTube Playlist Embed Node Represents a YouTube playlist embed. This type is specifically for playlist URLs that contain a list parameter, allowing for embedding entire playlists rather than single videos.

I
YoutubeNode

YouTube Embed Node Represents a YouTube video embed with detailed information about the video and its URL parameters. Supports various YouTube URL formats including youtube.com, youtu.be, and YouTube Shorts.

f
focusEnd
No documentation available
f
addTextInputEventListener

Add an event listener to the #text-input element with automatic re-registration

f
caret

Retrieves the current cursor position and text selection information

I
CaretInfo

Cursor information contained within the React Component that builds #text-input

f
click

Emulate click event sequences

I
I
CodeBlock

Represents a single code block within a source file

I
CodeFile

Represents a single source code file with its code blocks

T
CommitMakeHandler

Function type for creating commits to be pushed

f
computeLine
No documentation available
f
connect

connect to websocket

f
cursor
No documentation available
f
cursorLine
No documentation available
f
deleteLines
No documentation available
f
deletePage

Delete a specified page whose title is title from a given project

T
DeletePageOptions
No documentation available
f
disconnect

Disconnect the websocket

f
downBlocks
No documentation available
f
downLines
No documentation available
f
editor
No documentation available
f
extractCodeFiles

Extract code blocks from scrapbox.Page.lines

f
fetchApiCache

Requests a cache update for the specified API

f
findLatestCache

Retrieves the latest response from the cache storage managed by scrapbox.io

f
generateCacheName
No documentation available
f
getBaseLine
No documentation available
f
getCharDOM
No documentation available
f
getChars
No documentation available
f
getDOMFromPoint
No documentation available
f
getFormula
No documentation available
f
getHeadCharDOM
No documentation available
f
getHeadLineDOM
No documentation available
f
getIndentCount
No documentation available
f
getIndentLineCount

Get the number of indented lines under the specified line

f
getIndex
No documentation available
f
getLine
No documentation available
f
getLineCount
No documentation available
f
getLineDOM
No documentation available
f
getLineId

Get the line id from value

f
getLineNo

Get the line number from value

f
getLines
No documentation available
f
getNextLine
No documentation available
f
getPrevLine
No documentation available
f
getTailCharDOM
No documentation available
f
getTailLineDOM
No documentation available
f
getText
No documentation available
f
goChar

Move cursor to a specific character position

f
goEnd

Move to the end of line

f
goEndWithoutBlank

Move to the last non-whitespace character

f
goHead

Move to the start of line

f
goHeadLine

Move to the start of the first line

f
goHeadWithoutBlank

Move to the start of line excluding indentation

f
goLastLine

Move to the end of the last line

f
goLine

Move to the end of a specified line

f
grid
No documentation available
f
holdDown

Emulate long tap event sequence

I
HoldDownOptions
No documentation available
f
indentBlocks
No documentation available
f
indentLines
No documentation available
f
insertIcon
No documentation available
f
insertLine
No documentation available
f
insertText
No documentation available
f
insertTimestamp
No documentation available
f
isCharDOM
No documentation available
f
isLineDOM
No documentation available
T
Item
No documentation available
I
ItemGroup
No documentation available
T
KeyName
No documentation available
f
lines
No documentation available
f
listen

Subscribe to WebSocket events from Scrapbox

T
ListenStreamError
No documentation available
I
ListenStreamOptions
No documentation available
T
MakePatchFn

Function used in patch to generate a patch from the current page state

f
moveBlocks
No documentation available
f
moveDown

Move the cursor down using ArrowDown key

f
moveLeft

Move the cursor left using ArrowLeft key

f
moveLines
No documentation available
f
moveLinesBefore
No documentation available
f
moveRight

Move the cursor right using ArrowRight key

f
moveUp

Move the cursor up using ArrowUp key

I
NewPageContent
No documentation available
f
open

Open a page

f
openInTheSameTab

Open a page in the same tab

I
OpenOptions
No documentation available
f
outdentBlocks
No documentation available
f
outdentLines
No documentation available
f
pageCustomButtons
No documentation available
f
pageEditButtons
No documentation available
f
pageEditMenu
No documentation available
f
pageInfoMenu
No documentation available
f
pageMenu
No documentation available
T
PageTransitionContext
No documentation available
I
PageTransitionContextQuery

Represents the state when navigating from search results to a specific page Used to track navigation that originates from a full-text search

f
patch

Modify an entire Scrapbox page by computing and sending only the differences

I
PatchMetadata
No documentation available
T
PatchOptions
No documentation available
f
pin

Pin a Scrapbox page to keep it at the top of the project

f
pinNumber

Calculate a pin number for sorting pinned pages

I
PinOptions
No documentation available
f
popupMenu
No documentation available
I
Position

Position information within the editor

f
prefetch

Executes prefetch operations for specified API URLs

f
press

Dispatches a keyboard event programmatically via JavaScript

f
push

Push changes to a specific page using WebSocket

T
PushError

Comprehensive error type for push operations

I
PushMetadata

Extended page metadata required for WebSocket operations

I
PushOptions

Configuration options for the push operation

f
pushPageTransition

Registers the page transition state and enables automatic scrolling to the linked content This function stores navigation context in localStorage, which is used to determine where to scroll on the next page load. This is particularly useful for maintaining context when users navigate between related pages or from search results.

f
randomJumpButton
No documentation available
I
Range

Represents a text selection range in the editor

f
redo
No documentation available
f
removeTextInputEventListener
No documentation available
f
replaceLines
No documentation available
I
RetryError

Error returned when push retry attempts are exhausted

f
saveApiCache

Saves a response to the REST API cache storage managed by scrapbox.io

T
ScrapboxSocket

A pre-configured Socket type for Scrapbox

f
scrollDown

Scroll one page down using PageDown key

f
scrollHalfDown

Scroll half a page down

f
scrollHalfUp

Scroll half a page up

f
scrollUp

Scroll one page up using PageUp key

f
selections
No documentation available
I
SimpleCodeFile

Interface for specifying code block content and metadata for updates

f
statusBar
No documentation available
f
takeCursor
No documentation available
f
takeInternalLines

Get a reference to Scrapbox's internal page content data

f
takeSelection
No documentation available
f
takeStores

Retrieve Scrapbox's internal cursor and selection stores from the DOM

f
textInput
No documentation available
f
undo
No documentation available
I
UnexpectedError

Error for unexpected conditions during push operations

f
unpin

Unpin a Scrapbox page, removing it from the pinned list

I
UnPinOptions
No documentation available
f
upBlocks
No documentation available
f
updateCodeBlock

Update the content of a code block in a Scrapbox page

I
UpdateCodeBlockOptions

Configuration options for code block updates

f
updateCodeFile

Update or create code blocks in a Scrapbox page via REST API

I
UpdateCodeFileOptions

Configuration options for updateCodeFile function

f
upLines
No documentation available
f
useStatusBar

Get a section of the status bar and return functions to manipulate it

I
UseStatusBarResult
No documentation available
f
focusEnd
No documentation available
f
addTextInputEventListener

Add an event listener to the #text-input element with automatic re-registration

f
caret

Retrieves the current cursor position and text selection information

I
CaretInfo

Cursor information contained within the React Component that builds #text-input

f
click

Emulate click event sequences

I
I
CodeBlock

Represents a single code block within a source file

I
CodeFile

Represents a single source code file with its code blocks

f
computeLine
No documentation available
f
cursor
No documentation available
f
cursorLine
No documentation available
f
deleteLines
No documentation available
f
downBlocks
No documentation available
f
downLines
No documentation available
f
editor
No documentation available
f
extractCodeFiles

Extract code blocks from scrapbox.Page.lines

f
fetchApiCache

Requests a cache update for the specified API

f
findLatestCache

Retrieves the latest response from the cache storage managed by scrapbox.io

f
generateCacheName
No documentation available
f
getBaseLine
No documentation available
f
getCharDOM
No documentation available
f
getChars
No documentation available
f
getDOMFromPoint
No documentation available
f
getFormula
No documentation available
f
getHeadCharDOM
No documentation available
f
getHeadLineDOM
No documentation available
f
getIndentCount
No documentation available
f
getIndentLineCount

Get the number of indented lines under the specified line

f
getIndex
No documentation available
f
getLine
No documentation available
f
getLineCount
No documentation available
f
getLineDOM
No documentation available
f
getLineId

Get the line id from value

f
getLineNo

Get the line number from value

f
getLines
No documentation available
f
getNextLine
No documentation available
f
getPrevLine
No documentation available
f
getTailCharDOM
No documentation available
f
getTailLineDOM
No documentation available
f
getText
No documentation available
f
goChar

Move cursor to a specific character position

f
goEnd

Move to the end of line

f
goEndWithoutBlank

Move to the last non-whitespace character

f
goHead

Move to the start of line

f
goHeadLine

Move to the start of the first line

f
goHeadWithoutBlank

Move to the start of line excluding indentation

f
goLastLine

Move to the end of the last line

f
goLine

Move to the end of a specified line

f
grid
No documentation available
f
holdDown

Emulate long tap event sequence

I
HoldDownOptions
No documentation available
f
indentBlocks
No documentation available
f
indentLines
No documentation available
f
insertIcon
No documentation available
f
insertLine
No documentation available
f
insertText
No documentation available
f
insertTimestamp
No documentation available
f
isCharDOM
No documentation available
f
isLineDOM
No documentation available
T
Item
No documentation available
I
ItemGroup
No documentation available
T
KeyName
No documentation available
f
lines
No documentation available
f
moveBlocks
No documentation available
f
moveDown

Move the cursor down using ArrowDown key

f
moveLeft

Move the cursor left using ArrowLeft key

f
moveLines
No documentation available
f
moveLinesBefore
No documentation available
f
moveRight

Move the cursor right using ArrowRight key

f
moveUp

Move the cursor up using ArrowUp key

f
open

Open a page

f
openInTheSameTab

Open a page in the same tab

I
OpenOptions
No documentation available
f
outdentBlocks
No documentation available
f
outdentLines
No documentation available
f
pageCustomButtons
No documentation available
f
pageEditButtons
No documentation available
f
pageEditMenu
No documentation available
f
pageInfoMenu
No documentation available
f
pageMenu
No documentation available
T
PageTransitionContext
No documentation available
I
PageTransitionContextQuery

Represents the state when navigating from search results to a specific page Used to track navigation that originates from a full-text search

f
popupMenu
No documentation available
I
Position

Position information within the editor

f
prefetch

Executes prefetch operations for specified API URLs

f
press

Dispatches a keyboard event programmatically via JavaScript

f
pushPageTransition

Registers the page transition state and enables automatic scrolling to the linked content This function stores navigation context in localStorage, which is used to determine where to scroll on the next page load. This is particularly useful for maintaining context when users navigate between related pages or from search results.

f
randomJumpButton
No documentation available
I
Range

Represents a text selection range in the editor

f
redo
No documentation available
f
removeTextInputEventListener
No documentation available
f
replaceLines
No documentation available
f
saveApiCache

Saves a response to the REST API cache storage managed by scrapbox.io

f
scrollDown

Scroll one page down using PageDown key

f
scrollHalfDown

Scroll half a page down

f
scrollHalfUp

Scroll half a page up

f
scrollUp

Scroll one page up using PageUp key

f
selections
No documentation available
f
statusBar
No documentation available
f
takeCursor
No documentation available
f
takeInternalLines

Get a reference to Scrapbox's internal page content data

f
takeSelection
No documentation available
f
takeStores

Retrieve Scrapbox's internal cursor and selection stores from the DOM

f
textInput
No documentation available
f
undo
No documentation available
f
upBlocks
No documentation available
f
upLines
No documentation available
f
useStatusBar

Get a section of the status bar and return functions to manipulate it

I
UseStatusBarResult
No documentation available
f
focusEnd
No documentation available
T
CommitMakeHandler

Function type for creating commits to be pushed

f
connect

connect to websocket

f
deletePage

Delete a specified page whose title is title from a given project

T
DeletePageOptions
No documentation available
f
disconnect

Disconnect the websocket

f
listen

Subscribe to WebSocket events from Scrapbox

T
ListenStreamError
No documentation available
I
ListenStreamOptions
No documentation available
T
MakePatchFn

Function used in patch to generate a patch from the current page state

I
NewPageContent
No documentation available
f
patch

Modify an entire Scrapbox page by computing and sending only the differences

I
PatchMetadata
No documentation available
T
PatchOptions
No documentation available
f
pin

Pin a Scrapbox page to keep it at the top of the project

f
pinNumber

Calculate a pin number for sorting pinned pages

I
PinOptions
No documentation available
f
push

Push changes to a specific page using WebSocket

T
PushError

Comprehensive error type for push operations

I
PushMetadata

Extended page metadata required for WebSocket operations

I
PushOptions

Configuration options for the push operation

I
RetryError

Error returned when push retry attempts are exhausted

T
ScrapboxSocket

A pre-configured Socket type for Scrapbox

I
SimpleCodeFile

Interface for specifying code block content and metadata for updates

I
UnexpectedError

Error for unexpected conditions during push operations

f
unpin

Unpin a Scrapbox page, removing it from the pinned list

I
UnPinOptions
No documentation available
f
updateCodeBlock

Update the content of a code block in a Scrapbox page

I
UpdateCodeBlockOptions

Configuration options for code block updates

f
updateCodeFile

Update or create code blocks in a Scrapbox page via REST API

I
UpdateCodeFileOptions

Configuration options for updateCodeFile function

rest

Cosense REST API wrapper

T
CodeBlockError
No documentation available
I
ExportInit

Configuration options for the exportPages function

f
exportPages

Export all pages from a Scrapbox project

T
ExportPagesError
No documentation available
I
FileCapacityError

Error that occurs when storage capacity is exceeded

I
GCSError

Google Cloud Storage XML API error

I
GCSFile

Metadata for the uploaded file

f
getCachedAt

Get the timestamp when a response was cached by the ServiceWorker

I
GetCodeBlock
No documentation available
v
getCodeBlock

Retrieve text content from a specified code block

f
getCodeBlocks

Extract all code blocks from a Scrapbox page

I
GetCodeBlocksFilter

Filter options for getCodeBlocks()

f
getCSRFToken

Retrieve the CSRF token for secure requests

f
getGyazoToken

Retrieve an OAuth access token for uploading images to Gyazo

I
GetGyazoTokenOptions
No documentation available
I
GetLinksOptions
No documentation available
I
GetLinksResult
No documentation available
I
GetPage
No documentation available
v
getPage

Retrieves JSON data for a specified page

I
GetPageOption

Options for getPage

I
GetProfile
No documentation available
v
getProfile
No documentation available
I
GetProject
No documentation available
v
getProject

Get detailed information about a Scrapbox project

f
getSnapshot

Retrieve a specific version of a page from its snapshot history

I
GetTable
No documentation available
v
getTable

Retrieve a specified table in CSV format from a Scrapbox page

f
getTimestampIds

Retrieves the timestamp IDs for a specific page in a project.

f
getTweetInfo

Retrieve information about a specified Tweet

f
getWebPageTitle

Retrieve the title of a web page through Scrapbox's server

T
GyazoTokenError
No documentation available
f
importPages

Import pages into a Scrapbox project

T
ImportPagesError
No documentation available
I
InvalidFollowingIdError

Error that occurs when an invalid followingId is provided for pagination

I
InvalidPageSnapshotIdError

Error that occurs when an invalid timestampId is provided to getSnapshot

T
LinksError
No documentation available
I
ListPages
No documentation available
v
listPages

Lists pages from a specified project

T
ListPagesError
No documentation available
I
I
ListProjects
No documentation available
v
listProjects

List information for multiple Scrapbox projects

T
ListProjectsError
No documentation available
T
PageError
No documentation available
T
ProfileError
No documentation available
T
ProjectError
No documentation available
f
readLinksBulk

Retrieve all link data from a specified project in bulk

T
ReplaceLinksError
No documentation available
f
searchForJoinedProjects

Search across all projects that the user has joined

T
SearchForJoinedProjectsError
No documentation available
f
searchForPages

Search for pages within a specific project

T
SearchForPagesError
No documentation available
f
searchForWatchList

Search within a list of watched projects

T
SearchForWatchListError
No documentation available
T
SnapshotError

Union type of all possible errors that can occur when retrieving a page snapshot

T
SnapshotTimestampIdsError

Union type of all possible errors that can occur when retrieving snapshot timestamp IDs

T
TableError
No documentation available
I
TinyCodeBlock

Minimal information about a code block that can be extracted from pull() response

I
TooLongURIError
No documentation available
T
TweetInfoError
No documentation available
T
UploadGCSError
No documentation available
f
uploadToGCS

Upload any file to scrapbox.io

T
WebPageTitleError
No documentation available
f
getIndentCount

Count the number of leading whitespace characters (indentation level)

f
getIndentLineCount

Count the number of subsequent lines that are indented under the specified line

f
encodeTitleURI

Encode a title into a URI-safe format

f
revertTitleLc

Convert underscores (_) to single-byte spaces ( )

f
toReadableTitleURI

Convert a title to a URI-safe format while minimizing percent encoding

f
toTitleLc

Convert a string to titleLc format

I
BaseOptions

Common options shared across all REST API endpoints

T
Export1HopLinksOptions

Options for export1HopLinks

T
Export2HopLinksOptions

Options for export2HopLinks

I
ExtendedOptions

Extended options including CSRF token configuration

f
getCommits

Retrieves the commit history for a specified page

I
GetCommitsOption

Options for getCommits

f
getIcon

Retrieves a specified page image

I
GetIconOption

Options for getIcon

I
GetLinksOptions

Options for getLinks

f
getLinksStream

Retrieve all link data from a specified project one by one

f
getPage

Retrieves JSON data for a specified page

I
GetPageOption

Options for getPage

f
getProject

Get detailed information about a Scrapbox project

f
getText

Retrieves a specified page text

I
GetTextOption

Options for getText

f
getUser

get the user profile

I
HTTPError
No documentation available
I
InvalidHeadError

Represents an error when the commit HEAD is invalid.

f
listPages

Lists pages from a specified project

I
f
listPagesStream

Lists pages from a given project with pagination

I
ListPagesStreamOption

Options for listPagesStream

f
makeExport1HopLinksRequest

Constructs a request for the /api/smart-context/export-1hop-links/:project.txt endpoint

f
makeExport2HopLinksRequest

Constructs a request for the /api/smart-context/export-2hop-links/:project.txt endpoint

f
makeGetCommitsRequest

Constructs a request for the /api/commits/:project/:pageId endpoint

f
makeGetIconRequest

Constructs a request for the /api/pages/:project/:title/icon endpoint

f
makeGetLinksRequest

Create a request to GET /api/pages/:project/search/titles

f
makeGetPageRequest

Constructs a request for the /api/pages/:project/:title endpoint

f
makeGetProjectRequest

Create a request to GET /api/projects/:project

f
makeGetRequest

Constructs a request for the /api/pages/:project endpoint

f
makeGetTextRequest

Constructs a request for the /api/pages/:project/:title/text endpoint

f
makeGetUserRequest

Constructs a request for the /api/users/me endpoint

f
makeReplaceLinksRequest

Constructs a request for the /api/pages/:project/replace/links endpoint

f
makeSearchForPagesRequest

Constructs a request for the /api/pages/:project/search/query endpoint

I
OAuthOptions

Options for Gyazo API which requires OAuth

f
searchForPages

Search for pages within a specific project

I
TypedError
No documentation available
f
getCommits

Retrieves the commit history for a specified page

I
GetCommitsOption

Options for getCommits

I
InvalidHeadError

Represents an error when the commit HEAD is invalid.

f
makeGetCommitsRequest

Constructs a request for the /api/commits/:project/:pageId endpoint

f
getCommits

Retrieves the commit history for a specified page

I
GetCommitsOption

Options for getCommits

I
InvalidHeadError

Represents an error when the commit HEAD is invalid.

f
makeGetCommitsRequest

Constructs a request for the /api/commits/:project/:pageId endpoint

f
getCommits

Retrieves the commit history for a specified page

I
GetCommitsOption

Options for getCommits

I
InvalidHeadError

Represents an error when the commit HEAD is invalid.

f
makeGetCommitsRequest

Constructs a request for the /api/commits/:project/:pageId endpoint

f
getIcon

Retrieves a specified page image

I
GetIconOption

Options for getIcon

I
GetLinksOptions

Options for getLinks

f
getLinksStream

Retrieve all link data from a specified project one by one

f
getPage

Retrieves JSON data for a specified page

I
GetPageOption

Options for getPage

f
getText

Retrieves a specified page text

I
GetTextOption

Options for getText

f
listPages

Lists pages from a specified project

I
f
listPagesStream

Lists pages from a given project with pagination

I
ListPagesStreamOption

Options for listPagesStream

f
makeGetIconRequest

Constructs a request for the /api/pages/:project/:title/icon endpoint

f
makeGetLinksRequest

Create a request to GET /api/pages/:project/search/titles

f
makeGetPageRequest

Constructs a request for the /api/pages/:project/:title endpoint

f
makeGetRequest

Constructs a request for the /api/pages/:project endpoint

f
makeGetTextRequest

Constructs a request for the /api/pages/:project/:title/text endpoint

f
makeReplaceLinksRequest

Constructs a request for the /api/pages/:project/replace/links endpoint

f
makeSearchForPagesRequest

Constructs a request for the /api/pages/:project/search/query endpoint

f
searchForPages

Search for pages within a specific project

f
getIcon

Retrieves a specified page image

I
GetIconOption

Options for getIcon

I
GetLinksOptions

Options for getLinks

f
getLinksStream

Retrieve all link data from a specified project one by one

f
getPage

Retrieves JSON data for a specified page

I
GetPageOption

Options for getPage

f
getText

Retrieves a specified page text

I
GetTextOption

Options for getText

f
listPages

Lists pages from a specified project

I
f
listPagesStream

Lists pages from a given project with pagination

I
ListPagesStreamOption

Options for listPagesStream

f
makeGetIconRequest

Constructs a request for the /api/pages/:project/:title/icon endpoint

f
makeGetLinksRequest

Create a request to GET /api/pages/:project/search/titles

f
makeGetPageRequest

Constructs a request for the /api/pages/:project/:title endpoint

f
makeGetRequest

Constructs a request for the /api/pages/:project endpoint

f
makeGetTextRequest

Constructs a request for the /api/pages/:project/:title/text endpoint

f
makeReplaceLinksRequest

Constructs a request for the /api/pages/:project/replace/links endpoint

f
makeSearchForPagesRequest

Constructs a request for the /api/pages/:project/search/query endpoint

f
searchForPages

Search for pages within a specific project

f
makeReplaceLinksRequest

Constructs a request for the /api/pages/:project/replace/links endpoint

I
GetLinksOptions

Options for getLinks

f
getLinksStream

Retrieve all link data from a specified project one by one

f
makeGetLinksRequest

Create a request to GET /api/pages/:project/search/titles

f
makeSearchForPagesRequest

Constructs a request for the /api/pages/:project/search/query endpoint

f
searchForPages

Search for pages within a specific project

f
makeSearchForPagesRequest

Constructs a request for the /api/pages/:project/search/query endpoint

f
searchForPages

Search for pages within a specific project

I
GetLinksOptions

Options for getLinks

f
getLinksStream

Retrieve all link data from a specified project one by one

f
makeGetLinksRequest

Create a request to GET /api/pages/:project/search/titles

f
getIcon

Retrieves a specified page image

I
GetIconOption

Options for getIcon

f
getPage

Retrieves JSON data for a specified page

I
GetPageOption

Options for getPage

f
getText

Retrieves a specified page text

I
GetTextOption

Options for getText

f
makeGetIconRequest

Constructs a request for the /api/pages/:project/:title/icon endpoint

f
makeGetPageRequest

Constructs a request for the /api/pages/:project/:title endpoint

f
makeGetTextRequest

Constructs a request for the /api/pages/:project/:title/text endpoint

f
getIcon

Retrieves a specified page image

I
GetIconOption

Options for getIcon

f
makeGetIconRequest

Constructs a request for the /api/pages/:project/:title/icon endpoint

f
getText

Retrieves a specified page text

I
GetTextOption

Options for getText

f
makeGetTextRequest

Constructs a request for the /api/pages/:project/:title/text endpoint

f
getProject

Get detailed information about a Scrapbox project

f
makeGetProjectRequest

Create a request to GET /api/projects/:project

f
getProject

Get detailed information about a Scrapbox project

f
makeGetProjectRequest

Create a request to GET /api/projects/:project

T
Export1HopLinksOptions

Options for export1HopLinks

T
Export2HopLinksOptions

Options for export2HopLinks

f
makeExport1HopLinksRequest

Constructs a request for the /api/smart-context/export-1hop-links/:project.txt endpoint

f
makeExport2HopLinksRequest

Constructs a request for the /api/smart-context/export-2hop-links/:project.txt endpoint

f
getUser

get the user profile

f
makeGetUserRequest

Constructs a request for the /api/users/me endpoint

f
getUser

get the user profile

f
makeGetUserRequest

Constructs a request for the /api/users/me endpoint

New Ticket: Report package

Please provide a reason for reporting this package. We will review your report and take appropriate action.

Please review the JSR usage policy before submitting a report.