mirror of
https://github.com/SpaceVim/SpaceVim.git
synced 2025-01-24 06:20:05 +08:00
60 lines
1.2 KiB
Markdown
60 lines
1.2 KiB
Markdown
---
|
|
title: "system API"
|
|
description: "system API provides some basic functions and values for current os."
|
|
---
|
|
|
|
# [Available APIs](../) >> system
|
|
|
|
<!-- vim-markdown-toc GFM -->
|
|
|
|
- [Intro](#intro)
|
|
- [Valuables](#valuables)
|
|
- [Functions](#functions)
|
|
- [Usage](#usage)
|
|
|
|
<!-- vim-markdown-toc -->
|
|
|
|
## Intro
|
|
|
|
The `system` provides basic functions for os detection.
|
|
|
|
## Valuables
|
|
|
|
| name | values | description |
|
|
| --------- | :----: | -------------------------- |
|
|
| isWindows | 0 or 1 | check if the os is windows |
|
|
| isLinux | 0 or 1 | check if the os is linux |
|
|
| isOSX | 0 or 1 | check if the os is OSX |
|
|
|
|
## Functions
|
|
|
|
| name | description |
|
|
| ------------ | ---------------------------------------- |
|
|
| fileformat() | return the icon of current file format |
|
|
| isDarwin() | return 0 or 1, check if the os is Darwin |
|
|
|
|
## Usage
|
|
|
|
This api can be used in both vim script and lua script.
|
|
|
|
**vim script:**
|
|
|
|
```vim
|
|
let s:system = SpaceVim#api#import('system')
|
|
|
|
" check the if current os is Windows.
|
|
if s:system.isWindows
|
|
echom "OS is Windows"
|
|
endif
|
|
```
|
|
|
|
**lua script:**
|
|
|
|
```lua
|
|
local sys = require('spacevim.api').import('system')
|
|
|
|
if sys.isWindows == 1 then
|
|
print('this is windows os!')
|
|
end
|
|
```
|