Files
tauri/tooling/api/src/app.ts
Lucas Fernandes Nogueira f7892cf4ff feat(api): documentation (#1694)
* feat(api): documentation

* more docs [skip ci]
2021-05-05 14:36:40 -03:00

55 lines
1.1 KiB
TypeScript

// Copyright 2019-2021 Tauri Programme within The Commons Conservancy
// SPDX-License-Identifier: Apache-2.0
// SPDX-License-Identifier: MIT
/**
* Get application metadata.
* @packageDocumentation
*/
import { invokeTauriCommand } from './helpers/tauri'
/**
* Gets the application version.
*
* @returns A promise resolving to the application version.
*/
async function getVersion(): Promise<string> {
return invokeTauriCommand<string>({
__tauriModule: 'App',
message: {
cmd: 'getAppVersion'
}
})
}
/**
* Gets the application name.
*
* @returns A promise resolving to application name.
*/
async function getName(): Promise<string> {
return invokeTauriCommand<string>({
__tauriModule: 'App',
message: {
cmd: 'getAppName'
}
})
}
/**
* Gets the tauri version.
*
* @returns A promise resolving to tauri version.
*/
async function getTauriVersion(): Promise<string> {
return invokeTauriCommand<string>({
__tauriModule: 'App',
message: {
cmd: 'getTauriVersion'
}
})
}
export { getName, getVersion, getTauriVersion }