useEnv

• Category: Composables
• Relate: getEnv
• Dependencies: @lark-base-open/js-sdk
• Last Changed: 20 hours ago

提示

该函数需要在一个多维表格中使用，请将本文档作为一个插件在多维表格上使用以查看演示。

演示

Source

显示演示代码

demo.vue

<script setup lang="ts">
import { useEnv } from "@qww0302/use-bitable"
const env = useEnv()
</script>

<template>
  <p>Environment: {{ env ?? "null" }}</p>
</template>

用法

useEnv 是对 getEnv 的封装，用于获取当前环境信息。可以用它来判断当前是否处于多维表格中，非多维表格环境它的值为 null。

import { useEnv } from "@qww0302/use-bitable"
import { computed } from "vue"

const env = useEnv()
const isBitable = computed(() => !!env.value)

类型声明

import { Product } from "@lark-base-open/js-sdk"
/**
 * Get current environment
 *
 * 获取当前环境
 *
 * @returns
 */
export declare function useEnv(): import("vue").Ref<
  Product | null,
  Product | null
>