Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Readme Suggestion #8

Open
kk343 opened this issue Jul 19, 2022 · 0 comments
Open

Readme Suggestion #8

kk343 opened this issue Jul 19, 2022 · 0 comments

Comments

@kk343
Copy link

kk343 commented Jul 19, 2022

Under translate(text, options), it is better to leave a blank line for each feature description and put the explanation in brackets for smoother reading. The modified result is as follows:

text

Type: string, array

The text to be translated

options

Type: object

from? Type: string Default: auto
(The text language. Must be auto or one of the codes/names (not case sensitive) contained in src/languages.ts)

to Type: string Default: en
(The language in which the text should be translated. Must be one of the codes/names (not case sensitive) contained in src/languages.ts.)

tld Type: string 'com' | 'cn' <Default 'com'>
(cn is for China, com for others.)

proxy Type: AxiosProxyConfig
(proxy for request. )

config Type: object
(config for axios)

(This is for homework requirements, thank you.)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant