Home > LIB_Classification > getIndexByName

LIB_Classification.getIndexByName() method

This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Warning: This API is now obsolete.

since EDA v3.2; dropped EDA v3.3

Get the classification index of the classification with the specified name

Signature

function getIndexByName(
	libraryUuid: string,
	libraryType: ELIB_LibraryType,
	primaryClassificationName: string,
	secondaryClassificationName?: string,
): Promise<ILIB_ClassificationIndex | undefined>;

Parameters

Parameter	Type	Description
libraryUuid	string	Library UUID
libraryType	ELIB_LibraryType	Library type
primaryClassificationName	string	Primary classification name
secondaryClassificationName	string	(Optional) Secondary classification name

Returns

Promise<ILIB_ClassificationIndex | undefined>

Classification index

Remarks

The classification index contains the UUID of the classification. For details, refer to ILIB_ClassificationIndex

Example

// 1. 获取个人库 UUID
const libraryUuid = await eda.lib_LibrariesList.getPersonalLibraryUuid();

// 2. 创建两级测试分类（复用模块库，ELIB_LibraryType.CBB = '1'）
const tag = Date.now();
const primaryName = `嘉立创示例_按名索引一级_${tag}`;
const secondaryName = `嘉立创示例_按名索引二级_${tag}`;
const primaryIndex = await eda.lib_Classification.createPrimary(libraryUuid, '1', primaryName);
await eda.lib_Classification.createSecondary(
	libraryUuid,
	'1',
	primaryIndex.primaryClassificationUuid,
	secondaryName
);

// 3. 只按一级名称查索引
const primaryOnly = await eda.lib_Classification.getIndexByName(libraryUuid, '1', primaryName);

// 4. 按一级 + 二级名称查索引（secondaryClassificationName 可选）
const withSecondary = await eda.lib_Classification.getIndexByName(
	libraryUuid,
	'1',
	primaryName,
	secondaryName
);

// 5. 清理测试分类（查询类需要清理）
await eda.lib_Classification.deleteByUuid(libraryUuid, primaryIndex.primaryClassificationUuid);

console.log('primaryOnly.primaryClassificationUuid:', primaryOnly.primaryClassificationUuid);
console.log('withSecondary.secondaryClassificationUuid:', withSecondary.secondaryClassificationUuid);