Back to Spacevim

file API

docs/api/file.md

2.4.01.3 KB
Original Source

Available APIs >> file

<!-- vim-markdown-toc GFM --> <!-- vim-markdown-toc -->

values

namedescription
separatorThe system-dependent name-separator character.
pathSeparatorThe system-dependent path-separator character.

functions

namedescription
fticon(file)return the icon of specific file name or path
write(message, file)append message to file
override(message, file)override message to file
read(file)read message from file
ls(dir, if_file_only)list files and directorys in specific directory
updateFiles(files)update the contents of all files

Usage

This api can be used in both vim script and lua script.

vim script:

vim
let s:FILE = SpaceVim#api#import('file')
echom S:FILE.separator

lua script:

lua
local file_api = require('spacevim.api').import('file')
print(file_api.separator)