Class SharelistContext

Community sharelist management context.

Index

Constructors

Methods

new list detail popular create delete addSecurities removeSecurities sortSecurities

Constructors

constructor

new SharelistContext(): SharelistContext
Returns SharelistContext

Methods

`Static`new

new(config: Config): SharelistContext
Create a new SharelistContext.
Parameters
- config: Config
Returns SharelistContext

list

list(count: number): Promise<SharelistList>
List user's own and subscribed sharelists.

count controls how many sharelists are returned per category.
Parameters
- count: number
Returns Promise<SharelistList>

detail

detail(id: number): Promise<SharelistDetail>
Get sharelist detail including constituent stocks and subscription info.
Parameters
- id: number
Returns Promise<SharelistDetail>

popular

popular(count: number): Promise<SharelistList>
Get popular (trending) sharelists.
Parameters
- count: number
Returns Promise<SharelistList>

create

create(name: string, description?: string | null): Promise<void>
Create a new sharelist.
Parameters
- name: string
- Optionaldescription: string | null
Returns Promise<void>

delete

delete(id: number): Promise<void>
Delete a sharelist.
Parameters
- id: number
Returns Promise<void>

addSecurities

addSecurities(id: number, symbols: string[]): Promise<void>
Add securities to a sharelist.
Parameters
- id: number
- symbols: string[]
Returns Promise<void>

removeSecurities

removeSecurities(id: number, symbols: string[]): Promise<void>
Remove securities from a sharelist.
Parameters
- id: number
- symbols: string[]
Returns Promise<void>

sortSecurities

sortSecurities(id: number, symbols: string[]): Promise<void>
Reorder securities in a sharelist.
Parameters
- id: number
- symbols: string[]
Returns Promise<void>