# Documentation for RED.library?

**URL:** <https://discourse.nodered.org/t/documentation-for-red-library/55609>\
**Category:** Developing Nodes\
**Created:** [23 December 2021 12:36 UTC](https://discourse.nodered.org/t/documentation-for-red-library/55609 "2021-12-23T12:36:59Z")\
**Posts on this page:** 10\
**Page:** 1

<div class="post-metadata">

**Author:** ![Fredrik](https://sea2.discourse-cdn.com/flex026/user_avatar/discourse.nodered.org/fredrik/32/107652_2.png) [@Fredrik](https://discourse.nodered.org/u/Fredrik)\
**Post date:** [23 December 2021 12:36 UTC](https://discourse.nodered.org/t/documentation-for-red-library/55609/1 "2021-12-23T12:36:59Z")

</div>

I stumbled upon RED.library, and would love to use it for ingress and egress functions in my [node-red-contrib-hal2](https://flows.nodered.org/node/node-red-contrib-hal2) node, but I can't figure out how it works.

Is there some documentation or other examples than the template and the function node source code?

More specifically I couldn't figure out how to get the library icon to show up in the UI, and how the 'fields' parameter works.

---

<div class="post-metadata">

**Author:** ![TotallyInformation](https://sea2.discourse-cdn.com/flex026/user_avatar/discourse.nodered.org/totallyinformation/32/31_2.png) [@TotallyInformation](https://discourse.nodered.org/u/TotallyInformation)\
**Post date:** [23 December 2021 12:44 UTC](https://discourse.nodered.org/t/documentation-for-red-library/55609/2 "2021-12-23T12:44:57Z")

</div>

[Library Store API : Node-RED (nodered.org)](https://nodered.org/docs/api/library/)

---

<div class="post-metadata">

**Author:** ![Fredrik](https://sea2.discourse-cdn.com/flex026/user_avatar/discourse.nodered.org/fredrik/32/107652_2.png) [@Fredrik](https://discourse.nodered.org/u/Fredrik)\
**Post date:** [23 December 2021 13:02 UTC](https://discourse.nodered.org/t/documentation-for-red-library/55609/3 "2021-12-23T13:02:43Z")

</div>

Thanks, but is that really the same thing as

```auto
RED.library.create({
                url:"templates", // where to get the data from
                type:"template", // the type of object the library is for
                editor:that.editor, // the field name the main text body goes to
                fields:['name','format','output','syntax'],
                ext: "txt"
            });

```

...in the template node source code?

---

<div class="post-metadata">

**Author:** ![TotallyInformation](https://sea2.discourse-cdn.com/flex026/user_avatar/discourse.nodered.org/totallyinformation/32/31_2.png) [@TotallyInformation](https://discourse.nodered.org/u/TotallyInformation)\
**Post date:** [23 December 2021 13:03 UTC](https://discourse.nodered.org/t/documentation-for-red-library/55609/4 "2021-12-23T13:03:40Z")

</div>

Sorry, don't know, I've not used the feature yet. I've only used the examples folder in my nodes.

---

<div class="post-metadata">

**Author:** ![MaddyP](https://sea2.discourse-cdn.com/flex026/user_avatar/discourse.nodered.org/maddyp/32/53046_2.png) [@MaddyP](https://discourse.nodered.org/u/MaddyP)\
**Post date:** [25 December 2021 22:15 UTC](https://discourse.nodered.org/t/documentation-for-red-library/55609/5 "2021-12-25T22:15:38Z")

</div>

Yes please! I’m trying to use this feature in my node development but it’s trial and error without docs.

---

<div class="post-metadata">

**Author:** ![knolleary](https://sea2.discourse-cdn.com/flex026/user_avatar/discourse.nodered.org/knolleary/32/3_2.png) [@knolleary](https://discourse.nodered.org/u/knolleary)\
**Post date:** [25 December 2021 22:21 UTC](https://discourse.nodered.org/t/documentation-for-red-library/55609/6 "2021-12-25T22:21:24Z")

</div>

I'll try to get it documented in the next week or so - holidays allowing.

---

<div class="post-metadata">

**Author:** ![MaddyP](https://sea2.discourse-cdn.com/flex026/user_avatar/discourse.nodered.org/maddyp/32/53046_2.png) [@MaddyP](https://discourse.nodered.org/u/MaddyP)\
**Post date:** [25 December 2021 22:24 UTC](https://discourse.nodered.org/t/documentation-for-red-library/55609/7 "2021-12-25T22:24:08Z")

</div>

Thank you and Merry Christmas!

---

<div class="post-metadata">

**Author:** ![Fredrik](https://sea2.discourse-cdn.com/flex026/user_avatar/discourse.nodered.org/fredrik/32/107652_2.png) [@Fredrik](https://discourse.nodered.org/u/Fredrik)\
**Post date:** [26 December 2021 13:07 UTC](https://discourse.nodered.org/t/documentation-for-red-library/55609/8 "2021-12-26T13:07:22Z")

</div>

Excellent, thank you! Merry Christmas!

---

<div class="post-metadata">

**Author:** ![MaddyP](https://sea2.discourse-cdn.com/flex026/user_avatar/discourse.nodered.org/maddyp/32/53046_2.png) [@MaddyP](https://discourse.nodered.org/u/MaddyP)\
**Post date:** [13 January 2022 04:17 UTC](https://discourse.nodered.org/t/documentation-for-red-library/55609/9 "2022-01-13T04:17:19Z")

</div>

@knolleary - might you be able to drop a note here when the docs are available? No rush, just don’t want to miss it. 😁

---

<div class="post-metadata">

**Author:** ![system](https://us1.discourse-cdn.com/flex026/uploads/nodered/original/1X/d073cd938eafa2e558d7c2cd59003b3ef4963033.png) [@system](https://discourse.nodered.org/u/system)\
**Post date:** [14 March 2022 04:17 UTC](https://discourse.nodered.org/t/documentation-for-red-library/55609/10 "2022-03-14T04:17:24Z")

</div>

This topic was automatically closed 60 days after the last reply. New replies are no longer allowed.