Mastodon components and helpers for Svelte, SvelteKit, and Fuz
8 modules ยท 29 declarations
CreateReplyFilters import type {CreateReplyFilters} from '@fuzdev/fuz_mastodon/mastodon.js'; (call)type (item: MastodonStatus, status_context: MastodonStatusContext): ReplyFilter | ReplyFilter[] | null
itemstatus_contextReplyFilter | ReplyFilter[] | nullCustomReplyFilter import type {CustomReplyFilter} from '@fuzdev/fuz_mastodon/mastodon.js'; typetype 'custom'
should_includetype (
status: MastodonStatus,
root_status: MastodonStatus,
status_context: MastodonStatusContext,
) => boolean
FavouritedByReplyFilter import type {FavouritedByReplyFilter} from '@fuzdev/fuz_mastodon/mastodon.js'; typetype 'favourited_by'
favourited_bytype Array<string>
(host: string, status_id: string, cache?: Map<string, { key: string; url: string; params: any; value: any; etag: string | null; last_modified: string | null; }> | null | undefined, log?: Logger | undefined, request?: RequestInit | undefined, token?: string | undefined, fetch?: { ...; } | undefined): Promise<...> import {fetch_mastodon_favourites} from '@fuzdev/fuz_mastodon/mastodon.js'; hoststringstatus_idstringcache?Map<string, { key: string; url: string; params: any; value: any; etag: string | null; last_modified: string | null; }> | null | undefinedlog?Logger | undefinedrequest?RequestInit | undefinedtoken?string | undefinedfetch?{ (input: RequestInfo | URL, init?: RequestInit | undefined): Promise<Response>; (input: string | Request | URL, init?: RequestInit | undefined): Promise<...>; } | undefinedPromise<MastodonFavourite[] | null> (host: string, id: string, cache?: Map<string, { key: string; url: string; params: any; value: any; etag: string | null; last_modified: string | null; }> | null | undefined, log?: Logger | undefined, request?: RequestInit | undefined, token?: string | undefined, fetch?: { ...; } | undefined): Promise<...> import {fetch_mastodon_status} from '@fuzdev/fuz_mastodon/mastodon.js'; hoststringidstringcache?Map<string, { key: string; url: string; params: any; value: any; etag: string | null; last_modified: string | null; }> | null | undefinedlog?Logger | undefinedrequest?RequestInit | undefinedtoken?string | undefinedfetch?{ (input: RequestInfo | URL, init?: RequestInit | undefined): Promise<Response>; (input: string | Request | URL, init?: RequestInit | undefined): Promise<...>; } | undefinedPromise<MastodonStatus | null> (host: string, id: string, cache?: Map<string, { key: string; url: string; params: any; value: any; etag: string | null; last_modified: string | null; }> | null | undefined, log?: Logger | undefined, request?: RequestInit | undefined, token?: string | undefined, fetch?: { ...; } | undefined): Promise<...> import {fetch_mastodon_status_context} from '@fuzdev/fuz_mastodon/mastodon.js'; hoststringidstringcache?Map<string, { key: string; url: string; params: any; value: any; etag: string | null; last_modified: string | null; }> | null | undefinedlog?Logger | undefinedrequest?RequestInit | undefinedtoken?string | undefinedfetch?{ (input: RequestInfo | URL, init?: RequestInit | undefined): Promise<Response>; (input: string | Request | URL, init?: RequestInit | undefined): Promise<...>; } | undefinedPromise<MastodonStatusContext | null> (root_status: MastodonStatus, status_context: MastodonStatusContext, reply_filter: ReplyFilter | ReplyFilter[] | null, cache: Map<...> | ... 1 more ... | undefined, log: Logger | undefined): Promise<...> import {filter_valid_replies} from '@fuzdev/fuz_mastodon/mastodon.js'; root_statusstatus_contextreply_filterReplyFilter | ReplyFilter[] | nullcacheMap<string, { key: string; url: string; params: any; value: any; etag: string | null; last_modified: string | null; }> | null | undefinedlogLogger | undefinedPromise<MastodonStatus[]> <T>(key: string, to_default_value: () => T, validate?: ((value: any) => asserts value is T) | undefined): T import {load_from_storage} from '@fuzdev/fuz_mastodon/storage.js'; Loads key and falls back to defaultValue.
If validate is provided and throws, it removes the key and returns undefined.
keystringto_default_value() => Tvalidate?((value: any) => asserts value is T) | undefinedT load_from_storage<T>Tmastodon_cache.svelte.ts view source
{ get: (error_message?: string | undefined) => MastodonCache; get_maybe: () => MastodonCache | undefined; set: (value: MastodonCache) => MastodonCache; } import {mastodon_cache_context} from '@fuzdev/fuz_mastodon/mastodon_cache.svelte.js'; mastodon_cache.svelte.ts view source
import {MastodonCache} from '@fuzdev/fuz_mastodon/mastodon_cache.svelte.js'; load_datatype () => Promise<Array<[Url, FetchValueCacheItem]> | null>
dataIf undefined, it's still loading. null means no data.
type FetchValueCache | undefined | null
constructortype new (load_data: () => Promise<[Url, { key: string; url: string; params: any; value: any; etag: string | null; last_modified: string | null; }][] | null>, load_on_mount?: boolean): MastodonCache
load_data() => Promise<[Url, { key: string; url: string; params: any; value: any; etag: string | null; last_modified: string | null; }][] | null>load_on_mountbooleantrueloadtype () => Promise<void>
MastodonFavourite import type {MastodonFavourite} from '@fuzdev/fuz_mastodon/mastodon.js'; idtype string
usernametype string
accttype string
display_nametype string
lockedtype boolean
bottype boolean
discoverabletype boolean
grouptype boolean
created_attype string
notetype string
urltype string
avatartype string
avatar_statictype string
headertype string
header_statictype string
followers_counttype number
following_counttype number
statuses_counttype number
last_status_attype string
emojistype Array<unknown>
fieldstype Array<{
name: string;
value: string;
verified_at: string; // Datetime
}>
MastodonStatus import type {MastodonStatus} from '@fuzdev/fuz_mastodon/mastodon.js'; idtype string
created_attype string
in_reply_to_idtype string
in_reply_to_account_idtype string
sensitivetype boolean
spoiler_texttype string
visibilitytype string
languagetype string
uritype string
urltype string
replies_counttype number
reblogs_counttype number
favourites_counttype number
edited_attype null | string
favouritedtype boolean
rebloggedtype boolean
mutedtype boolean
bookmarkedtype boolean
contenttype string
filteredtype Array<unknown>
reblogtype unknown
accounttype {
id: string;
username: string;
acct: string;
display_name: string;
locked: boolean;
bot: boolean;
discoverable: boolean;
group: boolean;
created_at: string;
note: string;
url: string;
avatar: string;
avatar_static: string;
header: string;
header_static: string;
followers_count: number;
following_count: number;
statuses_count: number;
last_status_at: string;
emojis: Array<unknown>;
fields: Array<unknown>;
}
media_attachmentstype Array<unknown>
mentionstype [
{
id: string;
username: string;
url: string;
acct: string;
},
]
tagstype [
{
name: string;
url: string;
},
]
emojistype Array<unknown>
cardtype unknown
polltype unknown
MastodonStatusContext import type {MastodonStatusContext} from '@fuzdev/fuz_mastodon/mastodon.js'; result from https://:host/api/v1/statuses/:id/context.
ancestorstype Array<MastodonStatus>
descendantstype Array<MastodonStatus>
MastodonStatusItem.svelte view source
import MastodonStatusItem from '@fuzdev/fuz_mastodon/MastodonStatusItem.svelte'; itemMastodonStatusTree.svelte view source
import MastodonStatusTree from '@fuzdev/fuz_mastodon/MastodonStatusTree.svelte'; itemitemsMastodonStatus[]MastodonStatusUrl import type {MastodonStatusUrl} from '@fuzdev/fuz_mastodon/mastodon.js'; hreftype string
hosttype string
status_idtype string
author?type string
MinimumFavouritesReplyFilter import type {MinimumFavouritesReplyFilter} from '@fuzdev/fuz_mastodon/mastodon.js'; typetype 'minimum_favourites'
minimum_favouritestype number
(url: string): MastodonStatusUrl | null import {parse_mastodon_status_url} from '@fuzdev/fuz_mastodon/mastodon.js'; parses a url to a post or API endpoint for a post, aka Mastodon status context.
urlstringMastodonStatusUrl | null the parsed host and id params, if any
ReplyFilter import type {ReplyFilter} from '@fuzdev/fuz_mastodon/mastodon.js'; When filtering replies, at least one rule must pass for a reply to be included.
(key: string, value: any): void import {set_in_storage} from '@fuzdev/fuz_mastodon/storage.js'; Sets value at key.
Importantly, if value is undefined the key is removed,
but a value of null is stored.
keystringvalueanyvoid (host: string, id: string): string import {to_mastodon_api_favourites_url} from '@fuzdev/fuz_mastodon/mastodon.js'; hoststringidstringstring (host: string, id: string): string import {to_mastodon_api_status_context_url} from '@fuzdev/fuz_mastodon/mastodon.js'; hoststringidstringstring (host: string, id: string): string import {to_mastodon_api_status_url} from '@fuzdev/fuz_mastodon/mastodon.js'; hoststringidstringstring (host: string, id: string): string import {to_mastodon_status_url} from '@fuzdev/fuz_mastodon/mastodon.js'; hoststringidstringstring (host: string, id: string, author: string): string import {to_mastodon_status_url_with_author} from '@fuzdev/fuz_mastodon/mastodon.js'; hoststringidstringauthorstringstring (host: string, id: string, author: string): string import {to_mastodon_status_url_with_users_author} from '@fuzdev/fuz_mastodon/mastodon.js'; longhand for to_mastodon_status_url_with_author, apperas.
hoststringidstringauthorstringstring import Toot from '@fuzdev/fuz_mastodon/Toot.svelte'; urlstringupdated_url?Defaults to the url, but can be updated by user input.
stringurlinclude_ancestors?Whether to fetch and display the ancestors in the status context.
booleanfalseinclude_replies?Whether to fetch and display replies aka descendants in the status context.
booleanfalsereply_filter?Get a list of rules that controls whether replies are shown or not.
ReplyFilter | ReplyFilter[] | CreateReplyFilterscache?Optional API result cache.
See MastodonCache and get_mastodon_cache/set_mastodon_cache.
Map<string, { key: string; url: string; params: any; value: any; etag: string | null; last_modified: string | null; }>log?Optional logger for network calls.
Loggerloading?booleanload_time?numbersettings_storage_key?stringinitial_show_settings?booleanfalseshow_settings?booleanautoload_storage_key?string'autoload'initial_autoload?booleanfalseautoload?booleanautoload_storage_key
? load_from_storage(autoload_storage_key, () => initial_autoload)
: initial_autoloadonreset?() => voidsettings?Snippet<[]>import TootInput from '@fuzdev/fuz_mastodon/TootInput.svelte'; urlstringattrs?HTMLInputAttributesaccepts children
import TootLoader from '@fuzdev/fuz_mastodon/TootLoader.svelte'; hostThe host part of the url, like 'mastodon.ryanatkn.com'.
string | nullidThe status id to fetch, like '110702983310017651'.
string | nullinclude_ancestors?Whether to fetch and display the ancestors in the status context.
booleanfalseinclude_replies?Whether to fetch and display replies aka descendants in the status context.
booleanfalsecache?Optional API result cache.
Map<string, { key: string; url: string; params: any; value: any; etag: string | null; last_modified: string | null; }>log?Optional logger for network calls.
Loggerloading?booleanitem?status_context?replies?MastodonStatus[]reply_filter?Get a list of rules that controls whether replies are shown or not. If omitted, all replies are included.
ReplyFilter | ReplyFilter[] | CreateReplyFiltersload_time?numberchildrenSnippet<[{ item: MastodonStatus | null | undefined; status_context: MastodonStatusContext | null | undefined; replies: MastodonStatus[] | null | undefined; load: () => Promise<...>; loading: boolean | undefined; load_time: number | undefined; }]>arg0 { item: MastodonStatus | null | undefined; status_context: MastodonStatusContext | null | undefined; replies: MastodonStatus[] | null | undefined; load: () => Promise<...>; loading: boolean | undefined; load_time: number | undefined; }