azur-lane-api-new

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

HTTPMethods

ModelResolverOptions

ModelResolverOptions: { region: ResolverRegion; repo: string; token: string }

Type declaration

region: ResolverRegion
repo: string
token: string

MonthData

MonthData: {}

Type declaration

[key: number]: { Item: DropItem; count: number }
- Item: DropItem
- count: number

Newable

Newable<T>: {}

Type parameters

Type declaration

QueriedNextApiHandler

QueriedNextApiHandler<T>: (req: QueriedNextApiRequest<T>, res: NextApiResponse) => void | Promise<void>

Type parameters

Type declaration

- (req: QueriedNextApiRequest<T>, res: NextApiResponse): void | Promise<void>
- Parameters
  - req: QueriedNextApiRequest<T>
  - res: NextApiResponse
  Returns void | Promise<void>

ResolverRegion

ResolverRegion: "en" | "jp" | "cn" | "kr" | "tw"

ShipGroupDescriptionItem

ShipGroupDescriptionItem: [string, [ShipDescriptionAction, any]]

Transformer

Transformer: (o: unknown) => unknown

Type declaration

- (o: unknown): unknown
- Parameters
  - o: unknown
  Returns unknown

TreeItem

TreeItem: { mode: string; path: string; sha: string; size: number; type: string; url: string }

Type declaration

mode: string
path: string
sha: string
size: number
type: string
url: string

Variables

Let FileModel

FileModel: Model<IFileSchema>

Const FileSchema

FileSchema: Schema<any> = new mongoose.Schema({name: {type: String,required: true},hash: {type: String,required: true},contents: {type: Buffer,required: true}})

Const MODEL_DEPENDS_KEY

MODEL_DEPENDS_KEY: "nimi-model:depends" = "nimi-model:depends"

Const MODEL_EXCLUDE_KEY

MODEL_EXCLUDE_KEY: "nimi-model:exclude" = "nimi-model:exclude"

Const NAMECODE_REGEX

NAMECODE_REGEX: RegExp = /\{namecode:(\d+)\}/g

Const REGEX_CHECKPOINT

REGEX_CHECKPOINT: RegExp = /(\d+)-(\d+)/

Const REGEX_CONSTRUCT

REGEX_CONSTRUCT: RegExp = /(light|heavy|special)/gi

Const REGEX_EVENT

REGEX_EVENT: RegExp = /Event: (.+)/

Const SCHEMA_POSITION_KEY

SCHEMA_POSITION_KEY: "nimi-schema:position" = "nimi-schema:position"

Const TAG_REGEX

TAG_REGEX: RegExp = /<[^>]*>/g

Const compress

compress: (arg1: T1) => Promise<TResult> = util.promisify(snappy.compress)

Type declaration

- (arg1: T1): Promise<TResult>
- Parameters
  - arg1: T1
  Returns Promise<TResult>

Const cors

cors: (Anonymous function) = initMiddleware(Cors())

Const rate

rate: (Anonymous function) = initMiddleware(RateLimit({ windowMs: 60 * 60 * 1000, max: 150 }))

Const uncompress

uncompress: (arg1: T1, arg2: T2) => Promise<TResult> = util.promisify(snappy.uncompress)

Type declaration

- (arg1: T1, arg2: T2): Promise<TResult>
- Parameters
  - arg1: T1
  - arg2: T2
  Returns Promise<TResult>

Functions

Const connectDB

connectDB(): Promise<"mongoose">

- Defined in lib/database.ts:30
Returns Promise<"mongoose">

createFileEntry

createFileEntry(name: string, hash: string, contents: Buffer): Promise<void>

- Defined in lib/database.ts:48
Creates a new file entry in the database.

Parameters
- name: string
  
  the name of the file
- hash: string
  
  the hash identifier of the file, grab this from GitHub.
- contents: Buffer
  
  the buffered contents of the file. Recommended to use GZipped buffers here.
Returns Promise<void>

createModel

createModel(model: Newable<IModel>, schema?: Newable<Object>): NextApiHandler<any>

- Defined in lib/createModel.ts:39
A factory method that creates a NextApiHandler using the provided model and schema.

Parameters
- model: Newable<IModel>
  
  The model to be used in serialization.
- Default value schema: Newable<Object> = GetEntryByRegionQuery
  
  The model's argument as a schema that will be passed during its initialization.
Returns NextApiHandler<any>

deleteFileEntry

deleteFileEntry(name: string): Promise<void>

- Defined in lib/database.ts:95
Deletes a file entry in the database. Useful if the file is deprecated on new versions of the file sets.

Parameters
- name: string
  
  the name of the file to remove.
Returns Promise<void>

dependsOn

dependsOn(dependencies: Array<string>): ClassDecorator

- Defined in lib/models/model.helpers.ts:20
Denote a ShareCfgModel depends on data that will be resolved and passed to it's load method.

Parameters
- dependencies: Array<string>
  
  An array of dependency names as listed in ShareCfgResolver
Returns ClassDecorator

exclude

exclude(): PropertyDecorator

- Defined in lib/models/model.helpers.ts:7
Marks a property as private to be excluded from serialization.

Returns PropertyDecorator

formatMonth

formatMonth(month: any): {}

- Defined in lib/models/shared/model.monthly.ts:38
Parameters
- month: any
Returns {}

getFileEntry

getFileEntry(name: string): Promise<any>

- Defined in lib/database.ts:84
Gets a file entry from the DB and returns the entry as a JavaScript object.

Parameters
- name: string
  
  the name of the file.
Returns Promise<any>

the JavaScript object. This also contains the document id (_id). This is a instance of IFileModel as object.

handleError

handleError(fn: NextApiHandler): NextApiHandler

- Defined in lib/handleError.ts:28
Parameters
- fn: NextApiHandler
Returns NextApiHandler

initMiddleware

initMiddleware(middleware: any): (Anonymous function)

- Defined in lib/methods.ts:57
Parameters
- middleware: any
Returns (Anonymous function)

mapDialogue

mapDialogue(dialogue: any, codes: any): (Anonymous function)

- Defined in lib/models/ships/model.ship.skin.ts:56
Parameters
- dialogue: any
- codes: any
Returns (Anonymous function)

methods

methods(handlers: {}): NextApiHandler

- Defined in lib/methods.ts:43
Parameters
- handlers: {}
Returns NextApiHandler

position

position(order: number): (Anonymous function)

- Defined in lib/schemas.ts:41
Define what position this property wille be ordered in the schema.

Parameters
- order: number
  
  The position of the property in the schema.
Returns (Anonymous function)

replaceNameCodes

replaceNameCodes(str: string, codes: any): string

- Defined in lib/models/ships/model.ship.skin.ts:49
Parameters
- str: string
- codes: any
Returns string

updateFileEntry

updateFileEntry(name: string, hash: string, contents: Buffer): Promise<void>

- Defined in lib/database.ts:65
Updates a existing file entry in the database. Usually needed if the files has a new version somewhere.

Parameters
- name: string
  
  the name of the file. This needs to be consistent as this is used as a search term to the DB.
- hash: string
  
  the new hash identifier of the file. New versions of the file gets a new hash so you want to update this.
- contents: Buffer
  
  the new (GZipped) buffered contents of the files.
Returns Promise<void>

validate

validate<T>(schema: {}, handle: QueriedNextApiHandler<T>, target?: ValidationTarget): NextApiHandler

- Defined in lib/validate.ts:38
Type parameters
- T
Parameters
- schema: {}
- handle: QueriedNextApiHandler<T>
- Default value target: ValidationTarget = ValidationTarget.Query
Returns NextApiHandler

validateAction

validateAction(schema: Newable<Object>, model: Newable<IModel>): NextApiHandler

- Defined in lib/createModel.ts:16
Parameters
- schema: Newable<Object>
- model: Newable<IModel>
Returns NextApiHandler

Object literals

Const ACQUISITION_DEFAULTS

ACQUISITION_DEFAULTS: object

chapter

chapter: null = null

collection

collection: boolean = false

event

event: null = null

exchange

exchange: null = null

stage

stage: null = null

task

task: null = null

construction

construction: object

heavy

heavy: boolean = false

light

light: boolean = false

limited

limited: boolean = false

research

research: boolean = false

special

special: boolean = false

Const ACQUISITION_TASK

ACQUISITION_TASK: object

CBT Reward

CBT Reward: string = "closedBetaParticipant"

Hidden Mission:Im-paws-ible quest

Hidden Mission:Im-paws-ible quest: string = "akashiMissions"

Monthly Sign-in

Monthly Sign-in: string = "monthlySignIn"

Weekly Mission

Weekly Mission: string = "weeklyMission"

Const ACQUISITION_WARP

ACQUISITION_WARP: object

sham

sham: ShipExchangeLocation = ShipExchangeLocation.Core

supplies

supplies: ShipExchangeLocation = ShipExchangeLocation.Munitions

Const SHIP_ATTR_TYPE

SHIP_ATTR_TYPE: object

0

0: string = "health"

1

1: string = "cannon"

10

10: string = "luck"

11

11: string = "antiSub"

2

2: string = "torpedo"

3

3: string = "antiAir"

4

4: string = "aviation"

5

5: string = "reload"

6

6: string = "armor"

7

7: string = "hit"

8

8: string = "evasion"

9

9: string = "speed"

Const SHIP_DIALOGUE_MAP

SHIP_DIALOGUE_MAP: object

battle

battle: string = "startBattle"

detail

detail: string = "details"

drop_descrip

drop_descrip: string = "description"

expedition

expedition: string = "commission"

feeling1

feeling1: string = "affinityDisappointed"

feeling2

feeling2: string = "affinityStranger"

feeling3

feeling3: string = "affinityFriendly"

feeling4

feeling4: string = "affinityLike"

feeling5

feeling5: string = "affinityLove"

headtouch

headtouch: string = "headpat"

home

home: string = "return"

hp_warning

hp_warning: string = "lowHp"

login

lose

lose: string = "lose"

mail

mail: string = "mail"

main

main: string = "idle"

mission

mission: string = "task"

mission_complete

mission_complete: string = "taskComplete"

profile

profile: string = "selfIntroduction"

propose

propose: string = "pledge"

skill

skill: string = "skillActivate"

touch

touch: string = "touch"

touch2

touch2: string = "specialTouch"

unlock

unlock: string = "acquisition"

upgrade

upgrade: string = "strengthening"

win_mvp

win_mvp: string = "mvp"

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

HTTPMethods

ModelResolverOptions

Type declaration

region: ResolverRegion

repo: string

token: string

MonthData

Type declaration

[key: number]: { Item: DropItem; count: number }

Item: DropItem

count: number

Newable

Type parameters

T

Type declaration

QueriedNextApiHandler

Type parameters

T

Type declaration

Parameters

req: QueriedNextApiRequest<T>

res: NextApiResponse

Returns void | Promise<void>

ResolverRegion

ShipGroupDescriptionItem

Transformer

Type declaration

Parameters

o: unknown

Returns unknown

TreeItem

Type declaration

mode: string

path: string

sha: string

size: number

type: string

url: string

Variables

Let FileModel

Const FileSchema

Const MODEL_DEPENDS_KEY

Const MODEL_EXCLUDE_KEY

Const NAMECODE_REGEX

Const REGEX_CHECKPOINT

Const REGEX_CONSTRUCT

Const REGEX_EVENT

Const SCHEMA_POSITION_KEY

Const TAG_REGEX

Const compress

Type declaration

Parameters

arg1: T1

Returns Promise<TResult>

Const cors

Const rate

Const uncompress

Type declaration

Parameters

arg1: T1

arg2: T2

Returns Promise<TResult>

Functions

Const connectDB

Returns Promise<"mongoose">

createFileEntry

Parameters

name: string

hash: string

contents: Buffer

Returns Promise<void>