Methods
create
create( projectId: string , keyId: number , body: object ) : Promise < object >
Parameters
projectId: string
keyId: number
body: object
Returns Promise < object >
}
delete
delete( projectId: string , keyId: number , commentId: number ) : Promise < object >
Parameters
projectId: string
keyId: number
commentId: number
Returns Promise < object >
}
get
get( projectId: string , keyId: number , commentId: number ) : Promise < object >
Parameters
projectId: string
keyId: number
commentId: number
Returns Promise < object >
}
list
list( projectId: string , keyId?: number , query?: IPage ) : Promise < object >
Parameters
projectId: string
Optional keyId: number
Optional query: IPage
Returns Promise < object >
}
Legend
Module
Object literal
Variable
Function
Function with type parameter
Index signature
Type alias
Enumeration
Enumeration member
Property
Method
Interface
Interface with type parameter
Constructor
Property
Method
Index signature
Class
Class with type parameter
Constructor
Property
Method
Accessor
Index signature
Inherited constructor
Inherited property
Inherited method
Inherited accessor
Protected property
Protected method
Protected accessor
Private property
Private method
Private accessor
Static property
Static method
IComments
Comments can be used to give translators a context about the key, or as a discussion about certain aspects of translation for the key. There is a separate comments thread for each key. All comments are cross-posted into project chat.