@lytjs/metadata 6.8.0 → 6.9.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.cts +83 -0
- package/dist/index.d.ts +83 -0
- package/package.json +4 -4
package/dist/index.d.cts
ADDED
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
import { OpenGraphMetadata, TwitterMetadata, Metadata } from '@lytjs/shared-types';
|
|
2
|
+
export { Metadata, OpenGraphMetadata, TwitterMetadata } from '@lytjs/shared-types';
|
|
3
|
+
|
|
4
|
+
/**
|
|
5
|
+
* 元数据构建器
|
|
6
|
+
*/
|
|
7
|
+
|
|
8
|
+
/**
|
|
9
|
+
* 元数据构建器类
|
|
10
|
+
*/
|
|
11
|
+
declare class MetadataBuilder {
|
|
12
|
+
/** 元数据对象 */
|
|
13
|
+
private metadata;
|
|
14
|
+
/**
|
|
15
|
+
* 设置标题
|
|
16
|
+
*
|
|
17
|
+
* @param title - 标题
|
|
18
|
+
* @returns 构建器实例
|
|
19
|
+
*/
|
|
20
|
+
title(title: string): this;
|
|
21
|
+
/**
|
|
22
|
+
* 设置描述
|
|
23
|
+
*
|
|
24
|
+
* @param description - 描述
|
|
25
|
+
* @returns 构建器实例
|
|
26
|
+
*/
|
|
27
|
+
description(description: string): this;
|
|
28
|
+
/**
|
|
29
|
+
* 设置关键词
|
|
30
|
+
*
|
|
31
|
+
* @param keywords - 关键词数组
|
|
32
|
+
* @returns 构建器实例
|
|
33
|
+
*/
|
|
34
|
+
keywords(keywords: string[]): this;
|
|
35
|
+
/**
|
|
36
|
+
* 设置 Open Graph 元数据
|
|
37
|
+
*
|
|
38
|
+
* @param og - Open Graph 元数据
|
|
39
|
+
* @returns 构建器实例
|
|
40
|
+
*/
|
|
41
|
+
openGraph(og: OpenGraphMetadata): this;
|
|
42
|
+
/**
|
|
43
|
+
* 设置 Twitter 元数据
|
|
44
|
+
*
|
|
45
|
+
* @param twitter - Twitter 元数据
|
|
46
|
+
* @returns 构建器实例
|
|
47
|
+
*/
|
|
48
|
+
twitter(twitter: TwitterMetadata): this;
|
|
49
|
+
/**
|
|
50
|
+
* 设置自定义属性
|
|
51
|
+
*
|
|
52
|
+
* @param key - 键
|
|
53
|
+
* @param value - 值
|
|
54
|
+
* @returns 构建器实例
|
|
55
|
+
*/
|
|
56
|
+
set(key: string, value: unknown): this;
|
|
57
|
+
/**
|
|
58
|
+
* 构建元数据
|
|
59
|
+
*
|
|
60
|
+
* @returns 元数据对象
|
|
61
|
+
*/
|
|
62
|
+
build(): Metadata;
|
|
63
|
+
}
|
|
64
|
+
/**
|
|
65
|
+
* 创建元数据构建器
|
|
66
|
+
*
|
|
67
|
+
* @returns 构建器实例
|
|
68
|
+
*/
|
|
69
|
+
declare function createMetadataBuilder(): MetadataBuilder;
|
|
70
|
+
|
|
71
|
+
/**
|
|
72
|
+
* 元数据渲染器
|
|
73
|
+
*/
|
|
74
|
+
|
|
75
|
+
/**
|
|
76
|
+
* 渲染元数据为 HTML 标签
|
|
77
|
+
*
|
|
78
|
+
* @param metadata - 元数据对象
|
|
79
|
+
* @returns HTML 标签字符串
|
|
80
|
+
*/
|
|
81
|
+
declare function renderMetadata(metadata: Metadata): string;
|
|
82
|
+
|
|
83
|
+
export { MetadataBuilder, createMetadataBuilder, renderMetadata };
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
import { OpenGraphMetadata, TwitterMetadata, Metadata } from '@lytjs/shared-types';
|
|
2
|
+
export { Metadata, OpenGraphMetadata, TwitterMetadata } from '@lytjs/shared-types';
|
|
3
|
+
|
|
4
|
+
/**
|
|
5
|
+
* 元数据构建器
|
|
6
|
+
*/
|
|
7
|
+
|
|
8
|
+
/**
|
|
9
|
+
* 元数据构建器类
|
|
10
|
+
*/
|
|
11
|
+
declare class MetadataBuilder {
|
|
12
|
+
/** 元数据对象 */
|
|
13
|
+
private metadata;
|
|
14
|
+
/**
|
|
15
|
+
* 设置标题
|
|
16
|
+
*
|
|
17
|
+
* @param title - 标题
|
|
18
|
+
* @returns 构建器实例
|
|
19
|
+
*/
|
|
20
|
+
title(title: string): this;
|
|
21
|
+
/**
|
|
22
|
+
* 设置描述
|
|
23
|
+
*
|
|
24
|
+
* @param description - 描述
|
|
25
|
+
* @returns 构建器实例
|
|
26
|
+
*/
|
|
27
|
+
description(description: string): this;
|
|
28
|
+
/**
|
|
29
|
+
* 设置关键词
|
|
30
|
+
*
|
|
31
|
+
* @param keywords - 关键词数组
|
|
32
|
+
* @returns 构建器实例
|
|
33
|
+
*/
|
|
34
|
+
keywords(keywords: string[]): this;
|
|
35
|
+
/**
|
|
36
|
+
* 设置 Open Graph 元数据
|
|
37
|
+
*
|
|
38
|
+
* @param og - Open Graph 元数据
|
|
39
|
+
* @returns 构建器实例
|
|
40
|
+
*/
|
|
41
|
+
openGraph(og: OpenGraphMetadata): this;
|
|
42
|
+
/**
|
|
43
|
+
* 设置 Twitter 元数据
|
|
44
|
+
*
|
|
45
|
+
* @param twitter - Twitter 元数据
|
|
46
|
+
* @returns 构建器实例
|
|
47
|
+
*/
|
|
48
|
+
twitter(twitter: TwitterMetadata): this;
|
|
49
|
+
/**
|
|
50
|
+
* 设置自定义属性
|
|
51
|
+
*
|
|
52
|
+
* @param key - 键
|
|
53
|
+
* @param value - 值
|
|
54
|
+
* @returns 构建器实例
|
|
55
|
+
*/
|
|
56
|
+
set(key: string, value: unknown): this;
|
|
57
|
+
/**
|
|
58
|
+
* 构建元数据
|
|
59
|
+
*
|
|
60
|
+
* @returns 元数据对象
|
|
61
|
+
*/
|
|
62
|
+
build(): Metadata;
|
|
63
|
+
}
|
|
64
|
+
/**
|
|
65
|
+
* 创建元数据构建器
|
|
66
|
+
*
|
|
67
|
+
* @returns 构建器实例
|
|
68
|
+
*/
|
|
69
|
+
declare function createMetadataBuilder(): MetadataBuilder;
|
|
70
|
+
|
|
71
|
+
/**
|
|
72
|
+
* 元数据渲染器
|
|
73
|
+
*/
|
|
74
|
+
|
|
75
|
+
/**
|
|
76
|
+
* 渲染元数据为 HTML 标签
|
|
77
|
+
*
|
|
78
|
+
* @param metadata - 元数据对象
|
|
79
|
+
* @returns HTML 标签字符串
|
|
80
|
+
*/
|
|
81
|
+
declare function renderMetadata(metadata: Metadata): string;
|
|
82
|
+
|
|
83
|
+
export { MetadataBuilder, createMetadataBuilder, renderMetadata };
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@lytjs/metadata",
|
|
3
|
-
"version": "6.
|
|
3
|
+
"version": "6.9.1",
|
|
4
4
|
"description": "LytJS 元数据系统",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.cjs",
|
|
@@ -31,9 +31,9 @@
|
|
|
31
31
|
"clean": "rm -rf dist node_modules .turbo"
|
|
32
32
|
},
|
|
33
33
|
"dependencies": {
|
|
34
|
-
"@lytjs/common-is": "
|
|
35
|
-
"@lytjs/common-string": "
|
|
36
|
-
"@lytjs/shared-types": "
|
|
34
|
+
"@lytjs/common-is": "workspace:*",
|
|
35
|
+
"@lytjs/common-string": "workspace:*",
|
|
36
|
+
"@lytjs/shared-types": "workspace:*"
|
|
37
37
|
},
|
|
38
38
|
"devDependencies": {
|
|
39
39
|
"tsup": "^8.3.6",
|