API | Subsocial JS SDK

A set of API wrappers for Subsocial Network.

Index

Classes

Type aliases

Variables

Api

Type aliases

FindStructsFns

FindStructsFns: { findPosts: (ids: AnyPostId[]) => Promise<PostData[]>; findProfiles: (ids: AnyAccountId[]) => Promise<ProfileData[]>; findSpaces: (ids: AnySpaceId[]) => Promise<SpaceData[]> }

Type declaration

findPosts: (ids: AnyPostId[]) => Promise<PostData[]>
- - (ids: AnyPostId[]): Promise<PostData[]>
  - Parameters
    - ids: AnyPostId[]
    Returns Promise<PostData[]>
findProfiles: (ids: AnyAccountId[]) => Promise<ProfileData[]>
- - (ids: AnyAccountId[]): Promise<ProfileData[]>
  - Parameters
    - ids: AnyAccountId[]
    Returns Promise<ProfileData[]>
findSpaces: (ids: AnySpaceId[]) => Promise<SpaceData[]>
- - (ids: AnySpaceId[]): Promise<SpaceData[]>
  - Parameters
    - ids: AnySpaceId[]
    Returns Promise<SpaceData[]>

SubsocialApiProps

SubsocialApiProps: SubsocialContext & { ipfsNodeUrl: string; offchainUrl: string; substrateApi: SubstrateApi }

SubsocialIpfsProps

SubsocialIpfsProps: SubsocialContext & { ipfsNodeUrl: IpfsUrl; offchainUrl: string }

SupportedSubstrateId

SupportedSubstrateId: SubstrateId | AnyAccountId | ReactionId

SupportedSubstrateResult

SupportedSubstrateResult: CommonStruct | SocialAccount | Reaction

Variables

Const Api

Api: typeof SubstrateConnect = ...

Functions

asAccountId

asAccountId(id: AnyAccountId): GenericAccountId | undefined

- Defined in packages/api/src/utils/common.ts:35
Parameters
- id: AnyAccountId
Returns GenericAccountId | undefined

Const asIpfsCid

asIpfsCid(cid: IpfsCid): CID

- Defined in packages/api/src/utils/common.ts:83
Parameters
- cid: IpfsCid
Returns CID

contentFilter

contentFilter<T>(__namedParameters: Props<T>): T[]

- Defined in packages/api/src/utils/content-filter.ts:17
Type parameters
- T: HasContent
Parameters
- __namedParameters: Props<T>
Returns T[]

Const createResolveSubsocialApi

createResolveSubsocialApi(context: NewSubsocialApiProps): () => Promise<Api>

- Defined in packages/api/src/connections/subsocialConnect.ts:32
Parameters
- context: NewSubsocialApiProps
Returns () => Promise<Api>
- - (): Promise<Api>
  - Returns Promise<Api>

Const getApi

getApi(url: string): Promise<ApiPromise>

- Defined in packages/api/src/connections/substrateConnect.ts:77
Get the current open connection to Substrate node.

Parameters
- url: string
Returns Promise<ApiPromise>

getCidsOfStructs

getCidsOfStructs(structs: HasIpfsCidSomewhere[]): string[]

- Defined in packages/api/src/api/ipfs.ts:36
Extract ids of an array of structs.

Parameters
- structs: HasIpfsCidSomewhere[]
Returns string[]

getIpfsCidOfSocialAccount

getIpfsCidOfSocialAccount(struct: SocialAccountWithId): string | undefined

- Defined in packages/api/src/api/ipfs.ts:11
Return IPFS cid by social account struct

Parameters
- struct: SocialAccountWithId
Returns string | undefined

getIpfsCidOfStruct

getIpfsCidOfStruct<S>(struct: S): string | undefined

- Defined in packages/api/src/api/ipfs.ts:26
Try to resolve a corresponding IPFS CID of a given struct.

Type parameters
- S: HasIpfsCidSomewhere
Parameters
- struct: S
Returns string | undefined

Const getPostIdFromExtension

getPostIdFromExtension(postData?: HasPostStruct): PostId

- Defined in packages/api/src/utils/common.ts:63
Return original post id from shared post or root post id if this post is a comment.

Parameters
- Optional postData: HasPostStruct
Returns PostId

Const getSharedPostId

getSharedPostId(postData: any): PostId

- Defined in packages/api/src/utils/common.ts:48
Parameters
- postData: any
Returns PostId

Const getUniqueIds

getUniqueIds<ID>(ids: ID[]): ID[]

- Defined in packages/api/src/utils/common.ts:16
Type parameters
- ID: AnyId
Parameters
- ids: ID[]
Returns ID[]

Const isEmptyContent

isEmptyContent(struct?: StructWithHidden): boolean

- Defined in packages/api/src/utils/visibility-filter.ts:9
Parameters
- Optional struct: StructWithHidden
Returns boolean

Const isEmptyIpfsContent

isEmptyIpfsContent(struct?: HasContent): boolean

- Defined in packages/api/src/utils/content-filter.ts:13
Parameters
- Optional struct: HasContent
Returns boolean

Const isHidden

isHidden(struct?: StructWithHidden): boolean

- Defined in packages/api/src/utils/visibility-filter.ts:6
Parameters
- Optional struct: StructWithHidden
Returns boolean

Const isIpfs

isIpfs(content?: Content): any

- Defined in packages/api/src/utils/common.ts:81
Parameters
- Optional content: Content
Returns any

Const isPublic

isPublic(struct?: StructWithHidden): struct is StructWithHidden

- Defined in packages/api/src/utils/visibility-filter.ts:12
Parameters
- Optional struct: StructWithHidden
Returns struct is StructWithHidden

Const isUnlisted

isUnlisted(struct?: StructWithHidden): boolean

- Defined in packages/api/src/utils/visibility-filter.ts:11
Parameters
- Optional struct: StructWithHidden
Returns boolean

Const isValidIpfsCid

isValidIpfsCid(cid: IpfsCid): boolean

- Defined in packages/api/src/utils/common.ts:95
Parameters
- cid: IpfsCid
Returns boolean

Const isVisible

isVisible(struct?: StructWithHidden): struct is StructWithHidden

- Defined in packages/api/src/utils/visibility-filter.ts:7
Parameters
- Optional struct: StructWithHidden
Returns struct is StructWithHidden

loadAndSetPostRelatedStructs

loadAndSetPostRelatedStructs(posts: PostData[], finders: FindStructsFns, opts?: PostDetailsOpts): Promise<PostWithSomeDetails[]>

- Defined in packages/api/src/utils/loadPostStructs.ts:170
Load post structs and related structs like owner profile, space, root post if required.

Parameters
- posts: PostData[]
- finders: FindStructsFns
- Optional opts: PostDetailsOpts
Returns Promise<PostWithSomeDetails[]>

Const newSubsocialApi

newSubsocialApi(__namedParameters: NewSubsocialApiProps): Promise<Api>

- Defined in packages/api/src/connections/subsocialConnect.ts:20
Parameters
- __namedParameters: NewSubsocialApiProps
Returns Promise<Api>

Const notEmptyIpfsContent

notEmptyIpfsContent(struct?: HasContent): boolean

- Defined in packages/api/src/utils/content-filter.ts:15
Parameters
- Optional struct: HasContent
Returns boolean

Const resolveCidOfContent

resolveCidOfContent(content?: Content): string

- Defined in packages/api/src/utils/common.ts:103
Parameters
- Optional content: Content
Returns string

visibilityFilter

visibilityFilter<T>(structs: T[], filter?: Visibility): T[]

- Defined in packages/api/src/utils/visibility-filter.ts:14
Type parameters
- T: StructWithHidden
Parameters
- structs: T[]
- Optional filter: Visibility
Returns T[]