Class FavouriteList

Hierarchy

FavouriteList

Index

Constructors

Properties

Methods

add get getServers has deserialize fromServers serialize

Constructors

constructor

new FavouriteList(opts?: FavouriteListOptions): FavouriteList
Parameters
- opts: FavouriteListOptions = {}
Returns FavouriteList
- Defined in src/favourite-list.ts:70

Properties

`Private` `Readonly` servers

servers: SampFavouriteServer[] = []

Methods

add

add(server: Partial<SampFavouriteServer> & Pick<SampFavouriteServer, "ip" | "port">): SampFavouriteServer
Parameters
- server: Partial<SampFavouriteServer> & Pick<SampFavouriteServer, "ip" | "port">
Returns SampFavouriteServer
- Defined in src/favourite-list.ts:82

get

get(server: Pick<SampFavouriteServer, "ip" | "port">): null | SampFavouriteServer
Parameters
- server: Pick<SampFavouriteServer, "ip" | "port">
Returns null | SampFavouriteServer
- Defined in src/favourite-list.ts:94

getServers

getServers(): SampFavouriteServer[]
Returns SampFavouriteServer[]
- Defined in src/favourite-list.ts:74

has

has(server: Pick<SampFavouriteServer, "ip" | "port">): boolean
Parameters
- server: Pick<SampFavouriteServer, "ip" | "port">
Returns boolean
- Defined in src/favourite-list.ts:78

`Static` deserialize

deserialize(buffer: Buffer): SampFavouriteServer[]
Parameters
- buffer: Buffer
Returns SampFavouriteServer[]
- Defined in src/favourite-list.ts:22

`Static` fromServers

fromServers(servers: SampFavouriteServer[], opts?: FavouriteListOptions): FavouriteList
Parameters
- servers: SampFavouriteServer[]
- opts: FavouriteListOptions = {}
Returns FavouriteList
- Defined in src/favourite-list.ts:61

`Static` serialize

serialize(servers: SampFavouriteServer[]): Buffer
Parameters
- servers: SampFavouriteServer[]
Returns Buffer
- Defined in src/favourite-list.ts:42

Generated using TypeDoc