@blackglory/geyser-js 0.5.3 → 0.5.5

package/README.md

@@ -9,230 +9,163 @@ yarn add @blackglory/geyser-js
 ## API
 ### GeyserClient
 ```ts
-new GeyserClient({
+interface IGeyserClientOptions {
   server: string
-, token?: string
-, basicAuth?: {
+  token?: string
+  basicAuth?: {
     username: string
-  , password: string
+    password: string
   }
-, keepalive?: boolean
-, timeout?: number
-})
-```
+  keepalive?: boolean
+  timeout?: number
+}
 
-```ts
 interface IGeyserClientRequestOptions {
   signal?: AbortSignal
   token?: string
   keepalive?: boolean
   timeout?: number | false
 }
-```
 
-#### acquire
-```ts
-GeyserClient#acquire(
-  namespace: string
-, options?: IGeyserClientRequestOptions
-): Promise<void>
+class GeyserClient {
+  constructor(options: IGeyserClientOptions)
+
+  acquire(
+    namespace: string
+  , options: IGeyserClientRequestOptions = {}
+  ): Promise<void>
+}
 ```
 
 ### GeyserManager
 ```ts
-new GeyserManager({
+interface IGeyserManagerOptions {
   server: string
-, adminPassword: string
-, keepalive?: boolean
-, timeout?: number
-})
-```
-
-```ts
-interface IGeyserManagerRequestOptions {
-  signal?: AbortSignal
-, keepalive?: boolean
-, timeout?: number | false
+  adminPassword: string
+  keepalive?: boolean
+  timeout?: number
 }
-```
 
-#### Cycle
-##### resetCycle
-```ts
-GeyserManager#Cycle.resetCycle(
-  namespace: string
-, options?: IGeyserManagerRequestOptions
-): Promise<void>
-```
+class GeyserManager {
+  constructor(options: IGeyserManagerOptions)
 
-#### Configuration
-##### getNamespaces
-```ts
-GeyserManager#Configuration.getNamespaces(
-  options?: IGeyserManagerRequestOptions
-): Promise<string[]>
+  Configuration: ConfigurationClient
+  Cycle: CycleClient
+  Blacklist: BlacklistClient
+  Whitelist: WhitelistClient
+  TokenPolicy: TokenPolicyClient
+  Token: TokenClient
+}
 ```
 
-##### get
+#### ConfigurationClient
 ```ts
-GeyserManager#Configuration.get(
-  namespace: string
-, options?: IGeyserManagerRequestOptions
-): Promise<{
+interface IConfiguration {
   duration: number | null
   limit: number | null
-}>
-```
-
-##### setDuration
-```ts
-GeyserManager#Configuration.setDuration(
-  namespace: string
-, val: number
-, options?: IGeyserManagerRequestOptions
-): Promise<void>
-```
-
-##### removeDuration
-```ts
-GeyserManager#Configuration.removeDuration(
-  namespace: string
-, options?: IGeyserManagerRequestOptions
-): Promise<void>
-```
-
-##### setLimit
-```ts
-GeyserManager#Configuration.setLimit(
-  namespace: string
-, val: number
-, options?: IGeyserManagerRequestOptions
-): Promise<void>
-```
-
-##### removeLimit
-```ts
-GeyserManager#Configuration.removeLimit(
-  namespace: string
-, options?: IGeyserManagerRequestOptions
-): Promise<void>
-```
-
-#### Blacklist
-##### getNamespaces
-```ts
-GeyserManager#Blacklist.getNamespaces(
-  options?: IGeyserManagerRequestOptions
-): Promise<string[]>
-```
-
-##### add
-```ts
-GeyserManager#Blacklist.add(
-  namespace: string
-, options?: IGeyserManagerRequestOptions
-): Promise<void>
-```
-
-##### remove
-```ts
-GeyserManager#Blacklist.remove(
-  namespace: string
-, options?: IGeyserManagerRequestOptions
-): Promise<void>
-```
+}
 
-#### Whitelist
-##### getNamespaces
-```ts
-GeyserManager#Whitelist.getNamespaces(
-  options?: IGeyserManagerRequestOptions
-): Promise<string[]>
+class ConfigurationClient {
+  getNamespaces(options: IGeyserManagerRequestOptions = {}): Promise<string[]>
+  get(
+    namespace: string
+  , options: IGeyserManagerRequestOptions = {}
+  ): Promise<IConfiguration>
+  setDuration(
+    namespace: string
+  , val: number
+  , options: IGeyserManagerRequestOptions = {}
+  ): Promise<void>
+  removeDuration(
+    namespace: string
+  , options: IGeyserManagerRequestOptions = {}
+  ): Promise<void>
+  setLimit(
+    namespace: string
+  , val: number
+  , options: IGeyserManagerRequestOptions = {}
+  ): Promise<void>
+  removeLimit(
+    namespace: string
+  , options: IGeyserManagerRequestOptions = {}
+  ): Promise<void>
+}
 ```
 
-##### add
+#### CycleClient
 ```ts
-GeyserManager#Whitelist.add(
-  namespace: string
-, options?: IGeyserManagerRequestOptions
-): Promise<void>
+class CycleClient {
+  resetCycle(
+    namespace: string
+  , options: IGeyserManagerRequestOptions = {}
+  ): Promise<void>
+}
 ```
 
-##### remove
+#### BlacklistClient
 ```ts
-GeyserManager#Whitelist.remove(
-  namespace: string
-, options?: IGeyserManagerRequestOptions
-): Promise<void>
+class BlacklistClient {
+  getNamespaces(options: IGeyserManagerRequestOptions = {}): Promise<string[]>
+  add(namespace: string, options: IGeyserManagerRequestOptions = {}): Promise<void>
+  remove(namespace: string, options: IGeyserManagerRequestOptions = {}): Promise<void>
+}
 ```
 
-#### TokenPolicy
-##### getNamespaces
+#### WhitelistClient
 ```ts
-GeyserManager#TokenPolicy.getNamespaces(
-  options?: IGeyserManagerRequestOptions
-): Promise<string[]>
+class WhitelistClient {
+  getNamespaces(options: IGeyserManagerRequestOptions = {}): Promise<string[]>
+  add(namespace: string, options: IGeyserManagerRequestOptions = {}): Promise<void>
+  remove(namespace: string, options: IGeyserManagerRequestOptions = {}): Promise<void>
+}
 ```
 
-##### get
+#### TokenPolicyClient
 ```ts
-GeyserManager#TokenPolicy.get(
-  namespace: string
-, options?: IGeyserManagerRequestOptions
-): Promise<{
+interface ITokenPolicy {
   acquireTokenRequired: boolean | null
-}>
-```
-
-##### setAcquireTokenRequired
-```ts
-GeyserManager#TokenPolicy.setAcquireTokenRequired(
-  namespace: string
-, val: boolean
-, options?: IGeyserManagerRequestOptions
-): Promise<void>
-```
-
-##### removeAcquireTokenRequired
-```ts
-GeyserManager#TokenPolicy.removeAcquireTokenRequired(
-  namespace: string
-, options?: IGeyserManagerRequestOptions
-): Promise<void>
-```
+}
 
-#### Token
-##### getNamespaces
-```ts
-GeyserManager#Token.getNamespaces(
-  options?: IGeyserManagerRequestOptions
-): Promise<string[]>
+class TokenPolicyClient {
+  getNamespaces(options: IGeyserManagerRequestOptions = {}): Promise<string[]>
+  get(
+    namespace: string
+  , options: IGeyserManagerRequestOptions = {}
+  ): Promise<ITokenPolicy>
+  setAcquireTokenRequired(
+    namespace: string
+  , val: boolean
+  , options: IGeyserManagerRequestOptions = {}
+  ): Promise<void>
+  removeAcquireTokenRequired(
+    namespace: string
+  , options: IGeyserManagerRequestOptions = {}
+  ): Promise<void>
+}
 ```
 
-##### getTokens
+#### TokenClient
 ```ts
-GeyserManager#Token.getTokens(
-  namespace: string
-, options?: IGeyserManagerRequestOptions
-): Promise<Array<{
+interface ITokenInfo {
+  token: string
   acquire: boolean
-}>>
-```
-
-##### addAcquireToken
-```ts
-GeyserManager#Token.addAcquireToken(
-  namespace: string
-, token: string
-, options?: IGeyserManagerRequestOptions
-): Promise<void>
-```
+}
 
-##### removeAcquireToken
-```ts
-GeyserManager#Token.removeAcquireToken(
-  namespace: string
-, token: string
-, options?: IGeyserManagerRequestOptions
-): Promise<void>
+class TokenClient {
+  getNamespaces(options: IGeyserManagerRequestOptions = {}): Promise<string[]>
+  getTokens(
+    namespace: string
+  , options: IGeyserManagerRequestOptions = {}
+  ): Promise<ITokenInfo[]>
+  addAcquireToken(
+    namespace: string
+  , token: string
+  , options: IGeyserManagerRequestOptions = {}
+  ): Promise<void>
+  removeAcquireToken(
+    namespace: string
+  , token: string
+  , options: IGeyserManagerRequestOptions = {}
+  ): Promise<void>
+}
 ```