diff --git a/autoload/SpaceVim/api/data/number.vim b/autoload/SpaceVim/api/data/number.vim index 622a7dcbe..b1b29b58d 100644 --- a/autoload/SpaceVim/api/data/number.vim +++ b/autoload/SpaceVim/api/data/number.vim @@ -17,6 +17,18 @@ function! SpaceVim#api#data#number#get() abort \ ) endfunction +"" +" @section data#number, api-data-number +" @parentsection api +" data#number API provides some basic functions to generate number. +" +" random([{a}[, {b}]]) +" > +" random() : an unbounded random integer number. +" random(a) : an unbounded random number larger than a. +" random(a, b) : a random number from [a, a + b - 1]. +" < + " Random seed. if has('reltime') let s:rel = reltime() + reltime() @@ -29,10 +41,6 @@ else let [s:x, s:y, s:z, s:w] = [1, 2, 3, 4] endif -" Random number. -" random() : an unbounded random integer number. -" random(a) : an unbounded random number larger than a. -" random(a, b) : a random number from [a, a + b - 1]. function! s:random(...) abort let a = a:0 ? a:1 : 0 let b = a:0 > 1 ? a:2 : 0x1000000 diff --git a/doc/SpaceVim.txt b/doc/SpaceVim.txt index 4ca921f65..4e9b4ac01 100644 --- a/doc/SpaceVim.txt +++ b/doc/SpaceVim.txt @@ -169,18 +169,19 @@ CONTENTS *SpaceVim-contents* 1. cmdlinemenu................................|SpaceVim-api-cmdlinemenu| 2. data#dict....................................|SpaceVim-api-data-dict| 3. data#list....................................|SpaceVim-api-data-list| - 4. data#string................................|SpaceVim-api-data-string| - 5. job................................................|SpaceVim-api-job| - 6. logger..........................................|SpaceVim-api-logger| - 7. password......................................|SpaceVim-api-password| - 8. prompt..........................................|SpaceVim-api-prompt| - 9. sid............................................|SpaceVim-api-vim-sid| - 10. system.........................................|SpaceVim-api-system| - 11. vim#buffer.................................|SpaceVim-api-vim-buffer| - 12. vim#buffer.................................|SpaceVim-api-vim-window| - 13. vim#command...............................|SpaceVim-api-vim-command| - 14. vim#compatible.........................|SpaceVim-api-vim-compatible| - 15. vim#message...............................|SpaceVim-api-vim-message| + 4. data#number................................|SpaceVim-api-data-number| + 5. data#string................................|SpaceVim-api-data-string| + 6. job................................................|SpaceVim-api-job| + 7. logger..........................................|SpaceVim-api-logger| + 8. password......................................|SpaceVim-api-password| + 9. prompt..........................................|SpaceVim-api-prompt| + 10. sid...........................................|SpaceVim-api-vim-sid| + 11. system.........................................|SpaceVim-api-system| + 12. vim#buffer.................................|SpaceVim-api-vim-buffer| + 13. vim#buffer.................................|SpaceVim-api-vim-window| + 14. vim#command...............................|SpaceVim-api-vim-command| + 15. vim#compatible.........................|SpaceVim-api-vim-compatible| + 16. vim#message...............................|SpaceVim-api-vim-message| 9. FAQ........................................................|SpaceVim-faq| 10. Changelog...........................................|SpaceVim-changelog| @@ -3453,6 +3454,18 @@ char_range({from}, {to}) return a characters list based on the ascii number range. +============================================================================== +DATA#NUMBER *SpaceVim-api-data-number* + +data#number API provides some basic functions to generate number. + +random([{a}[, {b}]]) +> + random() : an unbounded random integer number. + random(a) : an unbounded random number larger than a. + random(a, b) : a random number from [a, a + b - 1]. +< + ============================================================================== DATA#STRING *SpaceVim-api-data-string* diff --git a/docs/api.md b/docs/api.md index b09a466de..27143b474 100644 --- a/docs/api.md +++ b/docs/api.md @@ -40,9 +40,11 @@ Here is the list of all available APIs, and welcome to contribute to SpaceVim. | Name | Description | | ------------------------------------- | -------------------------------------------------------------------------------------------------- | +| [cmdlinemenu](cmdlinemenu/) | cmdlinemenu API provides interface for making choices in a command line. | | [data#base64](data/base64/) | data#base64 API provides base64 encode and decode functions | | [data#dict](data/dict/) | data#dict API provides some basic functions and values for dict. | | [data#list](data/list/) | data#list API provides some basic functions and values for list. | +| [data#number](data/number/) | data#number API provides some basic functions to generate number. | | [data#string](data/string/) | data#string API provides some basic functions and values for string. | | [data#toml](data/toml/) | data#toml API provides some basic functions and values for toml. | | [file](file/) | file API provides some basic functions and values for current os. | @@ -53,8 +55,12 @@ Here is the list of all available APIs, and welcome to contribute to SpaceVim. | [system](system/) | system API provides some basic functions and values for current os. | | [transient-state](transient-state/) | transient state API provides some basic functions and values for current os. | | [unicode#spinners](unicode/spinners/) | unicode#spinners API provides some basic functions for starting spinners timer | +| [vim#buffer](vim/buffer/) | vim#buffer API provides some basic functions for setting and getting config of vim buffer. | | [vim#command](vim/command/) | vim#command API provides some basic functions and values for creatting vim custom command. | | [vim#highlight](vim/highlight/) | vim#highlight API provides some basic functions and values for getting and setting highlight info. | +| [vim#signatures](vim/signatures/) | vim#signatures API provides some basic functions for showing signatures info. | +| [vim#window](vim/window/) | vim#window API provides some basic functions for setting and getting config of vim window. | +| [vim](vim/) | vim API provides general vim functions. | | [web#html](web/html/) | web#html API provides some basic functions and values for parser html file. | | [web#http](web/http/) | web#http API provides some basic functions and values for http request | | [web#xml](web/xml/) | web#xml API provides some basic functions and values for parser xml file. | diff --git a/docs/api/data/number.md b/docs/api/data/number.md new file mode 100644 index 000000000..87ce4119b --- /dev/null +++ b/docs/api/data/number.md @@ -0,0 +1,30 @@ +--- +title: "data#number API" +description: "data#number API provides some basic functions to generate number." +--- + +# [Available APIs](../../) >> data#number + + + +- [Intro](#intro) +- [functions](#functions) + + + +## Intro + +`data#number` API provides some functions to manipulate a number. Here is an example for using this api: + +```vim +let s:NUM = SpaceVim#api#import('data#number') +let random_number = s:NUM.random(3, 10) +``` + +## functions + +| name | description | +| -------------- | ----------------------------------------- | +| `random()` | an unbounded random integer number. | +| `random(a)` | an unbounded random number larger than a. | +| `random(a, b)` | a random number from [a, a + b - 1]. | diff --git a/docs/api/transient-state.md b/docs/api/transient-state.md index 73d784b2f..09de3ea45 100644 --- a/docs/api/transient-state.md +++ b/docs/api/transient-state.md @@ -1,6 +1,6 @@ --- title: "transient state api" -description: "transient state API provides some besic functions and values for current os." +description: "transient state API provides some basic functions and values for current os." --- # [Available APIs](../) >> transient state diff --git a/docs/cn/api.md b/docs/cn/api.md index 80c6c9477..b918c53e8 100644 --- a/docs/cn/api.md +++ b/docs/cn/api.md @@ -45,8 +45,10 @@ echom s:file.pathSeparator | 名称 | 描述 | | ------------------------------------- | ----------------------------------------------------------------------- | +| [cmdlinemenu](cmdlinemenu/) | cmdlinemenu 函数提供了一套通过命令行进行选择的快捷接口。 | | [data#dict](data/dict/) | data#dict API 提供了一些处理字典变量的常用方法,包括基础的增删改查。 | | [data#list](data/list/) | data#list 函数库主要提供一些操作列表的常用函数。 | +| [data#number](data/number/) | data#number 函数库主要提供一些操作数字的常用函数。 | | [data#string](data/string/) | data#string 函数库主要提供一些操作字符串的常用函数。 | | [file](file/) | 文件函数提供了基础的文件读写相关函数,兼容不同系统平台。 | | [job](job/) | 兼容 neovim 和 vim 的异步协同 API,对于旧版 vim 采用非异步机制 | diff --git a/docs/cn/api/data/number.md b/docs/cn/api/data/number.md new file mode 100644 index 000000000..99a9cd8f8 --- /dev/null +++ b/docs/cn/api/data/number.md @@ -0,0 +1,31 @@ +--- +title: "data#number 函数库" +description: "data#number 函数库主要提供一些操作数字的常用函数。" +lang: zh +--- + +# [可用函数库](../../) >> data#number + + + +- [简介](#简介) +- [函数列表](#函数列表) + + + +## 简介 + +`data#number` 函数提供了一些操作数字的工具方法,以下为使用这一函数的示例: + +```vim +let s:NUM = SpaceVim#api#import('data#number') +let random_number = s:NUM.random(3, 10) +``` + +## 函数列表 + +| 函数名称 | 功能描述 | +| -------------- | ------------------------------- | +| `random()` | 一个随机整数 | +| `random(a)` | 一个大于 a 的随机整数 | +| `random(a, b)` | 大于 a,且小于 a + b 的随机整数 |